sander Thu Feb 28 11:21:17 2002 EDT
Modified files:
/phpdoc/en/functions var.xml misc.xml
Log:
Added and/or improved documentation for second argument of highlight_string(),
highlight_file(), show_source() and var_export().
Index: phpdoc/en/functions/var.xml
diff -u phpdoc/en/functions/var.xml:1.97 phpdoc/en/functions/var.xml:1.98
--- phpdoc/en/functions/var.xml:1.97 Thu Feb 21 04:11:48 2002
+++ phpdoc/en/functions/var.xml Thu Feb 28 11:21:11 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.97 $ -->
+<!-- $Revision: 1.98 $ -->
<reference id="ref.variables">
<title>Variable Functions</title>
<titleabbrev>Variables</titleabbrev>
@@ -1442,7 +1442,7 @@
<methodsynopsis>
<type>mixed</type><methodname>var_export</methodname>
<methodparam><type>mixed</type><parameter>expression</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>return</parameter></methodparam>
+ <methodparam
+choice="opt"><type>bool</type><parameter>return</parameter></methodparam>
</methodsynopsis>
<simpara>
This function returns structured information about the variable that is
Index: phpdoc/en/functions/misc.xml
diff -u phpdoc/en/functions/misc.xml:1.71 phpdoc/en/functions/misc.xml:1.72
--- phpdoc/en/functions/misc.xml:1.71 Wed Feb 27 14:07:36 2002
+++ phpdoc/en/functions/misc.xml Thu Feb 28 11:21:14 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.71 $ -->
+<!-- $Revision: 1.72 $ -->
<reference id="ref.misc">
<title>Miscellaneous functions</title>
<titleabbrev>Misc.</titleabbrev>
@@ -485,13 +485,27 @@
<methodsynopsis>
<type>bool</type><methodname>highlight_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
+ <methodparam
+ choice="opt"><type>bool</type><parameter>return</parameter></methodparam>
</methodsynopsis>
<simpara>
The <function>highlight_file</function> function prints out a syntax
higlighted version of the code contained in <parameter>filename</parameter>
using the colors defined in the built-in syntax highlighter for PHP.
- &return.success;
</simpara>
+ <simpara>
+ If the second parameter <parameter>return</parameter> is set to &true;
+ then <function>highlight_file</function> will return the highlighted
+ code as a string instead of printing it out. If the second parameter is
+ not set to &true; then <function>highlight_file</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>
<note>
<simpara>
Care should be taken when using the
@@ -573,7 +587,6 @@
</para>
</example>
</para>
- &tip.ob-capture;
<simpara>
See also <function>highlight_string</function>,
<function>show_source</function>.
@@ -591,7 +604,7 @@
<methodsynopsis>
<type>mixed</type><methodname>highlight_string</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
- <methodparam><type>int</type><parameter>return</parameter></methodparam>
+ <methodparam
+choice="opt"><type>bool</type><parameter>return</parameter></methodparam>
</methodsynopsis>
<simpara>
The <function>highlight_string</function> function outputs a syntax
@@ -862,14 +875,28 @@
<methodsynopsis>
<type>bool</type><methodname>show_source</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
+ <methodparam
+ choice="opt"><type>bool</type><parameter>return</parameter></methodparam>
</methodsynopsis>
<simpara>
The <function>show_source</function> function prints out a syntax
higlighted version of the code contained in <parameter>filename</parameter>
using the colors defined in the built-in syntax highlighter for PHP.
- It returns &true; on success, &false; otherwise (PHP 4).
</simpara>
<simpara>
+ If the second parameter <parameter>return</parameter> is set to &true;
+ then <function>show_source</function> will return the highlighted
+ code as a string instead of printing it out. If the second parameter is
+ not set to &true; then <function>show_source</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>
This function is an alias for the function
<function>highlight_file</function>
</simpara>
