cvs: phpdoc /en/functions misc.xml

sander Wed Feb 27 09:07:52 2002 EDT Modified files: /phpdoc/en/functions misc.xml Log: Added documentation for the new second parameter of highlight_string (#15650). Index: phpdoc/en/functions/misc.xml diff -u phpdoc/en/functions/misc.xml:1.69 phpdoc/en/functions/misc.xml:1.70 --- phpdoc/en/functions/misc.xml:1.69 Thu Feb 21 04:11:48 2002 +++ phpdoc/en/functions/misc.xml Wed Feb 27 09:07:52 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.69 $ --> +<!-- $Revision: 1.70 $ --> <reference id="ref.misc"> <title>Miscellaneous functions</title> <titleabbrev>Misc.</titleabbrev> @@ -589,16 +589,21 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>bool</type><methodname>highlight_string</methodname> + <type>mixed</type><methodname>highlight_string</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>int</type><parameter>return</parameter></methodparam> </methodsynopsis> <simpara> The <function>highlight_string</function> function prints out a syntax - highlighted version of <parameter>str</parameter> using the colors defined + highlighted version of <parameter>str</parameter> using the colors defined in the built-in syntax highlighter for PHP. - &return.success; </simpara> - &tip.ob-capture; + <simpara> + If the second parameter <parameter>return</parameter> is set to &true; + then <function>highlight_string</function> will return the highlighted + code as a string instead of printing it out. If the second parameter is + not set to &true;, it will return &true; on success, &false; on failure. + </simpara> <simpara> See also <function>highlight_file</function>, <function>show_source</function>.