cvs: phpdoc /en/reference/strings/functions str-word-count.xml

nlopess Sat Mar 12 18:08:02 2005 EDT Modified files: /phpdoc/en/reference/strings/functions str-word-count.xml Log: WS for new doc style http://cvs.php.net/diff.php/phpdoc/en/reference/strings/functions/str-word-count.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/strings/functions/str-word-count.xml diff -u phpdoc/en/reference/strings/functions/str-word-count.xml:1.5 phpdoc/en/reference/strings/functions/str-word-count.xml:1.6 --- phpdoc/en/reference/strings/functions/str-word-count.xml:1.5 Mon Dec 15 11:53:50 2003 +++ phpdoc/en/reference/strings/functions/str-word-count.xml Sat Mar 12 18:08:02 2005 @@ -1,52 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id="function.str-word-count"> - <refnamediv> - <refname>str_word_count</refname> - <refpurpose> - Return information about words used in a string - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>mixed</type><methodname>str_word_count</methodname> - <methodparam><type>string</type><parameter>string</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>format</parameter></methodparam> - </methodsynopsis> - <para> - Counts the number of words inside <parameter>string</parameter>. - If the optional <parameter>format</parameter> is not specified, then - the return value will be an integer representing the number of words - found. In the event the <parameter>format</parameter> is specified, the return - value will be an array, content of which is dependent on the - <parameter>format</parameter>. The possible value for the - <parameter>format</parameter> and the resultant outputs are listed below. - <itemizedlist> - <listitem> - <simpara> - 1 - returns an array containing all the words found inside the - <parameter>string</parameter>. - </simpara> - </listitem> - <listitem> - <simpara> - 2 - returns an associative array, where the key is the numeric - position of the word inside the <parameter>string</parameter> and - the value is the actual word itself. - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - For the purpose of this function, 'word' is defined as a locale dependent - string containing alphabetic characters, which also may contain, but not start - with &quot;'&quot; and &quot;-&quot; characters. - </para> - <para> - <example> - <title>Example uses for <function>str_word_count</function></title> - <programlisting role="php"> +<!-- $Revision: 1.6 $ --> +<refentry id="function.str-word-count"> + <refnamediv> + <refname>str_word_count</refname> + <refpurpose> + Return information about words used in a string + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>mixed</type><methodname>str_word_count</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>format</parameter></methodparam> + </methodsynopsis> + <para> + Counts the number of words inside <parameter>string</parameter>. + If the optional <parameter>format</parameter> is not specified, then + the return value will be an integer representing the number of words + found. In the event the <parameter>format</parameter> is specified, the return + value will be an array, content of which is dependent on the + <parameter>format</parameter>. The possible value for the + <parameter>format</parameter> and the resultant outputs are listed below. + <itemizedlist> + <listitem> + <simpara> + 1 - returns an array containing all the words found inside the + <parameter>string</parameter>. + </simpara> + </listitem> + <listitem> + <simpara> + 2 - returns an associative array, where the key is the numeric + position of the word inside the <parameter>string</parameter> and + the value is the actual word itself. + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + For the purpose of this function, 'word' is defined as a locale dependent + string containing alphabetic characters, which also may contain, but not start + with &quot;'&quot; and &quot;-&quot; characters. + </para> + <para> + <example> + <title>Example uses for <function>str_word_count</function></title> + <programlisting role="php"> <![CDATA[ <?php @@ -62,11 +62,9 @@ echo $c; ?> ]]> - </programlisting> - <para> - Output may look like: - </para> - <screen> + </programlisting> + &example.outputs; + <screen> <![CDATA[ Array @@ -92,18 +90,18 @@ 6 ]]> - </screen> - </example> - </para> - <para> - See also <function>explode</function>, - <function>preg_split</function>, - <function>split</function>, - <function>count_chars</function>, and - <function>substr_count</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <para> + See also <function>explode</function>, + <function>preg_split</function>, + <function>split</function>, + <function>count_chars</function>, and + <function>substr_count</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: