sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added documentation for the new second parameter of highlight_string (#15650).

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@71074 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sander Roobol 2002-02-27 14:07:52 +00:00
parent 2e21346a40
commit e87b06e9dd
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
functions/misc.xml
View file

@ -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 @@ http://your.server.com/source/path/to/script.php
<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>.