highlight_string: Add note regarding new str parameter 4.2.0 birthday.

And other minor updates.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@71088 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2002-02-27 19:07:36 +00:00
parent 378fc33953
commit 52cb4c6667

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.70 $ -->
<!-- $Revision: 1.71 $ -->
<reference id="ref.misc">
<title>Miscellaneous functions</title>
<titleabbrev>Misc.</titleabbrev>
@ -594,7 +594,7 @@ http://your.server.com/source/path/to/script.php
<methodparam><type>int</type><parameter>return</parameter></methodparam>
</methodsynopsis>
<simpara>
The <function>highlight_string</function> function prints out a syntax
The <function>highlight_string</function> function outputs a syntax
highlighted version of <parameter>str</parameter> using the colors defined
in the built-in syntax highlighter for PHP.
</simpara>
@ -602,10 +602,17 @@ http://your.server.com/source/path/to/script.php
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.
not set to &true; then <function>highlight_string</function> will
return &true; on success, &false; on failure.
</simpara>
<note>
<simpara>
The <parameter>return</parameter> parameter became available in PHP
4.2.0. Before this time it behaved like the default, which is &false;
</simpara>
</note>
<simpara>
See also <function>highlight_file</function>,
See also <function>highlight_file</function>, and
<function>show_source</function>.
</simpara>
</refsect1>