cvs: phpdoc /en/reference/fribidi constants.xml reference.xml /en/reference/fribidi/functions fribidi-log2vis.xml

didou Sun Jan 7 16:11:54 2007 UTC Modified files: /phpdoc/en/reference/fribidi constants.xml reference.xml /phpdoc/en/reference/fribidi/functions fribidi-log2vis.xml Log: Document fribidi_log2vis() Document missing constants Switch to new style http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fribidi/constants.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/fribidi/constants.xml diff -u phpdoc/en/reference/fribidi/constants.xml:1.2 phpdoc/en/reference/fribidi/constants.xml:1.3 --- phpdoc/en/reference/fribidi/constants.xml:1.2 Wed May 28 23:03:07 2003 +++ phpdoc/en/reference/fribidi/constants.xml Sun Jan 7 16:11:54 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <section id="fribidi.constants"> &reftitle.constants; &extension.constants; @@ -11,7 +11,7 @@ </term> <listitem> <simpara> - + Unicode </simpara> </listitem> </varlistentry> @@ -22,7 +22,7 @@ </term> <listitem> <simpara> - + Arabic </simpara> </listitem> </varlistentry> @@ -33,7 +33,7 @@ </term> <listitem> <simpara> - + Hebrew </simpara> </listitem> </varlistentry> @@ -44,7 +44,7 @@ </term> <listitem> <simpara> - + Hebrew/Yiddish </simpara> </listitem> </varlistentry> @@ -55,7 +55,7 @@ </term> <listitem> <simpara> - + Arabic </simpara> </listitem> </varlistentry> @@ -66,7 +66,51 @@ </term> <listitem> <simpara> - + Persian + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>FRIBIDI_CHARSET_CAP_RTL</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Used for test purposes, will treat CAPS as non-English letters + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>FRIBIDI_RTL</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Right to left + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>FRIBIDI_LTR</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Left to right + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>FRIBIDI_AUTO</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Autodetect the base direction </simpara> </listitem> </varlistentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fribidi/reference.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/fribidi/reference.xml diff -u phpdoc/en/reference/fribidi/reference.xml:1.8 phpdoc/en/reference/fribidi/reference.xml:1.9 --- phpdoc/en/reference/fribidi/reference.xml:1.8 Sun Sep 4 19:39:14 2005 +++ phpdoc/en/reference/fribidi/reference.xml Sun Jan 7 16:11:54 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- Purpose: international --> <!-- Membership: pecl, external --> @@ -34,8 +34,7 @@ <section id="fribidi.resources"> &reftitle.resources; - <para> - </para> + &no.resource; </section> &reference.fribidi.constants; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fribidi/functions/fribidi-log2vis.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/fribidi/functions/fribidi-log2vis.xml diff -u phpdoc/en/reference/fribidi/functions/fribidi-log2vis.xml:1.3 phpdoc/en/reference/fribidi/functions/fribidi-log2vis.xml:1.4 --- phpdoc/en/reference/fribidi/functions/fribidi-log2vis.xml:1.3 Tue Jul 19 14:30:06 2005 +++ phpdoc/en/reference/fribidi/functions/fribidi-log2vis.xml Sun Jan 7 16:11:54 2007 @@ -1,24 +1,61 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/fribidi.xml, last change in rev 1.1 --> - <refentry id="function.fribidi-log2vis"> - <refnamediv> - <refname>fribidi_log2vis</refname> - <refpurpose>Convert a logical string to a visual one</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>fribidi_log2vis</methodname> - <methodparam><type>string</type><parameter>str</parameter></methodparam> - <methodparam><type>string</type><parameter>direction</parameter></methodparam> - <methodparam><type>int</type><parameter>charset</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<refentry id="function.fribidi-log2vis"> + <refnamediv> + <refname>fribidi_log2vis</refname> + <refpurpose>Convert a logical string to a visual one</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>fribidi_log2vis</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>string</type><parameter>direction</parameter></methodparam> + <methodparam><type>int</type><parameter>charset</parameter></methodparam> + </methodsynopsis> + <para> + Converts a logical string to a vissual one. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The logical string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>direction</parameter></term> + <listitem> + <para> + One of <constant>FRIBIDI_RTL</constant>, + <constant>FRIBIDI_LTR</constant> or <constant>FRIBIDI_AUTO</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>charset</parameter></term> + <listitem> + <para> + One of the <literal>FRIBIDI_CHARSET_XXX</literal> constants. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the visual string on success, or &false; on failure. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: