reference/spl/filteriterator/valid.xml
8230e70922c5ef11f5f9a28806b6e782f46bea8b
...
...
@@ -1,4 +1,4 @@
1
-
<?xml version='1.0' encoding="utf-8"?>
1
+
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
3
<refentry xml:id="filteriterator.valid" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
...
...
@@ -8,16 +8,20 @@
8
8

9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
-
<methodsynopsis>
12
-
<type>bool</type><methodname>FilterIterator::valid</methodname>
11
+
<methodsynopsis role="FilterIterator">
12
+
<modifier>public</modifier> <type>bool</type><methodname>FilterIterator::valid</methodname>
13
13
<void/>
14
14
</methodsynopsis>
15
15

16
-
&warn.undocumented.func;
17
-

18
16
<para>
19
17
Checks whether the current element is valid.
20
18
</para>
19
+
<note>
20
+
<para>
21
+
The standard implementation of this function will initially return &false;
22
+
until the inner iterator is advanced to the first accepted element.
23
+
</para>
24
+
</note>
21
25
</refsect1>
22
26

23
27
<refsect1 role="parameters">
24
28