svn: /phpdoc/en/trunk/language/predefined/generator/ getreturn.xml key.xml send.xml throw.xml

From: Date: Sun, 20 Sep 2015 11:24:26 +0000
Subject: svn: /phpdoc/en/trunk/language/predefined/generator/ getreturn.xml key.xml send.xml throw.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-13738@lists.php.net to get a copy of this message
tpunt Sun, 20 Sep 2015 11:24:26 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=337857 Log: Document more of Generator class Changed paths: A phpdoc/en/trunk/language/predefined/generator/getreturn.xml U phpdoc/en/trunk/language/predefined/generator/key.xml U phpdoc/en/trunk/language/predefined/generator/send.xml U phpdoc/en/trunk/language/predefined/generator/throw.xml Added: phpdoc/en/trunk/language/predefined/generator/getreturn.xml =================================================================== --- phpdoc/en/trunk/language/predefined/generator/getreturn.xml (rev 0) +++ phpdoc/en/trunk/language/predefined/generator/getreturn.xml 2015-09-20 11:24:26 UTC (rev 337857) @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision$ --> + +<refentry xml:id="generator.getreturn" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>Generator::getReturn</refname> + <refpurpose>Get the return value</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>mixed</type><methodname>Generator::getReturn</methodname> + <void /> + </methodsynopsis> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the generator's return value once it has finished executing. + </para> + </refsect1> + +<refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><methodname>Generator::getReturn</methodname> example</title> + <programlisting role="php"> +<![CDATA[ +<?php + +$gen = (function() { + yield 1; + yield 2; + + return 3; +})(); + +foreach ($gen as $val) { + echo $val, PHP_EOL; +} + +echo $gen->getReturn(), PHP_EOL; +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +1 +2 +3 +]]> + </screen> + </example> + </para> + </refsect1> +</refentry> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +indent-tabs-mode:nil +sgml-parent-document:nil +sgml-default-dtd-file:"~/.phpdoc/manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +vim600: syn=xml fen fdm=syntax fdl=2 si +vim: et tw=78 syn=sgml +vi: ts=1 sw=1 +--> Modified: phpdoc/en/trunk/language/predefined/generator/key.xml =================================================================== --- phpdoc/en/trunk/language/predefined/generator/key.xml 2015-09-20 10:58:13 UTC (rev 337856) +++ phpdoc/en/trunk/language/predefined/generator/key.xml 2015-09-20 11:24:26 UTC (rev 337857) @@ -14,11 +14,8 @@ <void /> </methodsynopsis> <para> - + Gets the key of the yielded value. </para> - - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> @@ -33,7 +30,34 @@ </para> </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><methodname>Generator::key</methodname> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +function Gen() +{ + yield 'key' => 'value'; +} + +$gen = Gen(); + +echo "{$gen->key()} => {$gen->current()}"; +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +key => value +]]> + </screen> + </example> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file Modified: phpdoc/en/trunk/language/predefined/generator/send.xml =================================================================== --- phpdoc/en/trunk/language/predefined/generator/send.xml 2015-09-20 10:58:13 UTC (rev 337856) +++ phpdoc/en/trunk/language/predefined/generator/send.xml 2015-09-20 11:24:26 UTC (rev 337857) @@ -40,6 +40,13 @@ </variablelist> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the yielded value. + </para> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> @@ -71,14 +78,6 @@ </example> </para> </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the yielded value. - </para> - </refsect1> - </refentry> <!-- Keep this comment at the end of the file Modified: phpdoc/en/trunk/language/predefined/generator/throw.xml =================================================================== --- phpdoc/en/trunk/language/predefined/generator/throw.xml 2015-09-20 10:58:13 UTC (rev 337856) +++ phpdoc/en/trunk/language/predefined/generator/throw.xml 2015-09-20 11:24:26 UTC (rev 337857) @@ -37,6 +37,13 @@ </varlistentry> </variablelist> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the yielded value. + </para> + </refsect1> <refsect1 role="examples"> &reftitle.examples; @@ -73,16 +80,6 @@ </example> </para> </refsect1> - - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the yielded value. - </para> - </refsect1> - - </refentry> <!-- Keep this comment at the end of the file

« previous php.doc.cvs (#13738) next »