philip Wed Feb 27 14:07:36 2002 EDT
Modified files:
/phpdoc/en/functions misc.xml
Log:
highlight_string: Add note regarding new str parameter 4.2.0 birthday.
And other minor updates.
Index: phpdoc/en/functions/misc.xml
diff -u phpdoc/en/functions/misc.xml:1.70 phpdoc/en/functions/misc.xml:1.71
--- phpdoc/en/functions/misc.xml:1.70 Wed Feb 27 09:07:52 2002
+++ phpdoc/en/functions/misc.xml Wed Feb 27 14:07:36 2002
@@ -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 @@
<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 @@
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>
