cvs: phpdoc-fr /reference/misc/functions highlight-string.xml
| From: | Damien Seguy | Date: | Thu, 10 Oct 2002 01:16:12 +0000 |
| Subject: | cvs: phpdoc-fr /reference/misc/functions highlight-string.xml | ||
| Groups: | php.doc.fr | ||
| Request: | Send a blank email to doc-fr+get-62@lists.php.net to get a copy of this message | ||
dams Wed Oct 9 21:16:12 2002 EDT
Modified files:
/phpdoc-fr/reference/misc/functions highlight-string.xml
Log:
update
Index: phpdoc-fr/reference/misc/functions/highlight-string.xml
diff -u phpdoc-fr/reference/misc/functions/highlight-string.xml:1.1
phpdoc-fr/reference/misc/functions/highlight-string.xml:1.2
--- phpdoc-fr/reference/misc/functions/highlight-string.xml:1.1 Sun Apr 14 20:33:28 2002
+++ phpdoc-fr/reference/misc/functions/highlight-string.xml Wed Oct 9 21:16:12 2002
@@ -1,25 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- splitted from ./fr/functions/misc.xml, last change in rev 1.3 -->
-<!-- last change to 'highlight-string' in en/ tree in rev 1.22 -->
-<refentry id="function.highlight-string">
+<!-- $Revision: 1.2 $ -->
+<!-- splitted from ./en/functions/misc.xml, last change in rev 1.22 -->
+ <refentry id="function.highlight-string">
<refnamediv>
<refname>highlight_string</refname>
- <refpurpose>Colorisation d'une chaîne</refpurpose>
+ <refpurpose>Applique la syntaxe colorise du code PHP</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>void</type><methodname>highlight_string</methodname>
+ <type>mixed</type><methodname>highlight_string</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
+ <methodparam
choice="opt"><type>bool</type><parameter>return</parameter></methodparam>
</methodsynopsis>
<simpara>
- <function>highlight_string</function> affiche la version colorisée
- de la chaîne <parameter>str</parameter>, en utilisant les couleurs
- définies dans le moteur interne de PHP.
+ <function>highlight_string</function> affiche la version colorise
+ du code PHP contenu dans le paramtre <parameter>str</parameter>, en
+ utilisant les couleurs du systme interne de colorisation de PHP.
</simpara>
<simpara>
- Voir aussi
- <function>highlight_file</function> et
+ Si le second paramtre optionnel <parameter>return</parameter> est fourni,
+ et vaut &true; alors <function>highlight_string</function> retournera
+ la chane colorise au lieu de l'afficher immdaitement. Si le second
+ paramtre ne vaut pas &true; alors <function>highlight_string</function>
+ retournera &true; en cas de succs, et &false; sinon.
+ </simpara>
+ <note>
+ <simpara>
+ Le paramtre <parameter>return</parameter> est disponible depuis
+ PHP 4.2.0. Auparavant, il prenait la valeur par dfaut de &false;
+ </simpara>
+ </note>
+ <simpara>
+ Voir aussi
+ <function>highlight_file</function> et
<function>show_source</function>.
</simpara>
</refsect1>
@@ -44,4 +58,4 @@
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
--->
+-->
\ No newline at end of file