Skip to content

Commit 077aab2

Browse files
mmalferovcmb69
andauthored
ArrayIterator description: add tags and flesh out the description (#3933)
* Improving wording and add markup tags * reference/spl/arrayiterator.xml Replace links with tags Co-authored-by: Christoph M. Becker <[email protected]> --------- Co-authored-by: Christoph M. Becker <[email protected]>
1 parent 2a52232 commit 077aab2

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

reference/spl/arrayiterator.xml

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@
1111
&reftitle.intro;
1212
<para>
1313
Allows the removal of elements, and the modification of
14-
keys or values while iterating over Arrays or Objects.
14+
keys or values while iterating over <type>array</type>s or <type>object</type>s.
1515
</para>
1616
<para>
17-
When you want to iterate over the same array multiple times you need to
18-
instantiate ArrayObject and let it create ArrayIterator instances that
19-
refer to it either by using &foreach; or by calling its getIterator()
20-
method manually.
17+
To iterate the same array more than once, it is recommended to
18+
instantiate <classname>ArrayObject</classname> and use the
19+
<classname>ArrayIterator</classname> instance either implicitly created when
20+
using &foreach; to iterate over the array stored internally, or create one by
21+
calling the <methodname>ArrayObject::getIterator</methodname> method manually.
2122
</para>
2223
</section>
2324
<!-- }}} -->
@@ -82,7 +83,10 @@
8283
<varlistentry xml:id="arrayiterator.constants.std-prop-list">
8384
<term><constant>ArrayIterator::STD_PROP_LIST</constant></term>
8485
<listitem>
85-
<para>Properties of the object have their normal functionality when accessed as list (var_dump, foreach, etc.).</para>
86+
<para>
87+
Properties of the object have their normal functionality
88+
when accessed as list (<function>var_dump</function>, &foreach;, etc.).
89+
</para>
8690
</listitem>
8791
</varlistentry>
8892

0 commit comments

Comments
 (0)