Clarify use of return parameter. Fixes #50730

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@293493 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Peter Cowburn 2010-01-13 09:20:38 +00:00
parent fb6313be8c
commit 1f9807245a

View file

@ -49,9 +49,8 @@
<listitem>
<para>
If you would like to capture the output of <function>print_r</function>,
use the <parameter>return</parameter> parameter. If this parameter is set
to &true;, <function>print_r</function> will return its output, instead of
printing it (which it does by default).
use the <parameter>return</parameter> parameter. When this parameter is set
to &true;, <function>print_r</function> will return the information rather than print it.
</para>
</listitem>
</varlistentry>
@ -67,6 +66,10 @@
will be presented in a format that shows keys and elements. Similar
notation is used for <type>object</type>s.
</para>
<para>
When the <parameter>return</parameter> parameter is &true;, this function
will return a <type>string</type>. Otherwise, the return value is &true;.
</para>
</refsect1>
<refsect1 role="notes">