From 52cb4c6667e06dcf044bdf510af58cd3228bbd35 Mon Sep 17 00:00:00 2001
From: Philip Olson <philip@php.net>
Date: Wed, 27 Feb 2002 19:07:36 +0000
Subject: [PATCH] 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
---
 functions/misc.xml | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/functions/misc.xml b/functions/misc.xml
index 6bdf58cc31..5022ed9e2b 100644
--- a/functions/misc.xml
+++ b/functions/misc.xml
@@ -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>