[PHP-DOC] cvs: phpdoc /en/functions strings.xml From: brianlmoon (phpdoc <email protected>)
Date: 07/31/00

brianlmoon Mon Jul 31 07:09:34 2000 EDT

  Modified files:
    /phpdoc/en/functions strings.xml
  Log:
  added documentation for rtrim.
  
Index: phpdoc/en/functions/strings.xml
diff -u phpdoc/en/functions/strings.xml:1.30 phpdoc/en/functions/strings.xml:1.31
--- phpdoc/en/functions/strings.xml:1.30 Sat Jul 29 06:47:31 2000
+++ phpdoc/en/functions/strings.xml Mon Jul 31 07:09:34 2000
@@ -1337,6 +1337,33 @@
    </refsect1>
   </refentry>
 
+ <refentry id="function.rtrim">
+ <refnamediv>
+ <refname>rtrim</refname>
+ <refpurpose>Remove trailing whitespace.</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>string <function>rtrim</function></funcdef>
+ <paramdef>string <parameter>str</parameter></paramdef>
+ </funcsynopsis>
+ <para>
+ Returns the argument string without trailing whitespace,
+ including newlines. This is an alias for <function>chop</function>.
+ <example>
+ <title><function>rtrim</function> example</title>
+ <programlisting role="php">
+$trimmed = rtrim ($line);
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ See also <function>trim</function>, <function>ltrim</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
   <refentry id="function.setlocale">
    <refnamediv>
     <refname>setlocale</refname>