svn: /phpdoc/en/trunk/language/ generators.xml
| From: | Adam Harvey | Date: | Mon, 21 Sep 2015 12:16:43 +0000 |
| Subject: | svn: /phpdoc/en/trunk/language/ generators.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-13744@lists.php.net to get a copy of this message | ||
aharvey Mon, 21 Sep 2015 12:16:43 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=337865
Log:
Reinstate the generator object documentation earlier in the section.
This was meant to be in the previous commit, but oh well.
Changed paths:
U phpdoc/en/trunk/language/generators.xml
Modified: phpdoc/en/trunk/language/generators.xml
===================================================================
--- phpdoc/en/trunk/language/generators.xml 2015-09-21 12:16:39 UTC (rev 337864)
+++ phpdoc/en/trunk/language/generators.xml 2015-09-21 12:16:43 UTC (rev 337865)
@@ -94,6 +94,18 @@
]]>
</screen>
</example>
+
+ <sect2 xml:id="language.generators.object">
+ <title><classname>Generator</classname> objects</title>
+ <para>
+ When a generator function is called for the first time, an object of the
+ internal <classname>Generator</classname> class is returned. This object
+ implements the <classname>Iterator</classname> interface in much the same
+ way as a forward-only iterator object would, and provides methods that can
+ be called to manipulate the state of the generator, including sending
+ values to and returning values from it.
+ </para>
+ </sect2>
</sect1>
<sect1 xml:id="language.generators.syntax">