cvs: phpdoc /en/reference/tidy/functions tidy-error-count.xml tidy-reset-config.xml tidy-save-config.xml tidy-setopt.xml tidy-warning-count.xml

nlopess Wed Mar 3 13:24:08 2004 EDT Modified files: /phpdoc/en/reference/tidy/functions tidy-error-count.xml tidy-reset-config.xml tidy-save-config.xml tidy-setopt.xml tidy-warning-count.xml Log: more tidy stuff

http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-error-count.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/tidy/functions/tidy-error-count.xml diff -u phpdoc/en/reference/tidy/functions/tidy-error-count.xml:1.1 phpdoc/en/reference/tidy/functions/tidy-error-count.xml:1.2 --- phpdoc/en/reference/tidy/functions/tidy-error-count.xml:1.1 Tue Nov 4 08:26:55 2003 +++ phpdoc/en/reference/tidy/functions/tidy-error-count.xml Wed Mar 3 13:24:08 2004 @@ -1,6 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.tidy-error-count"> <refnamediv> <refname>tidy_error_count</refname> @@ -12,11 +11,49 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>tidy_error_count</methodname> - <void/> + <methodparam><type>resource</type><parameter>tidy</parameter></methodparam> </methodsynopsis> + <para> + <function>tidy_error_count</function> returns the number of Tidy errors + encountered for the specified document. + </para> + <para> + <example> + <title><function>tidy_error_count</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$html = '<p>test</i> +<bogustag>bogus</bogustag>'; - &warn.undocumented.func; +$tidy = tidy_parse_string($html); +echo tidy_error_count($tidy) . "\n"; //1 + +echo $tidy->error_buf; +?> +]]> + </programlisting> + <para> + The above example will output: + </para> + <screen> +<![CDATA[ +1 +line 1 column 1 - Warning: missing <!DOCTYPE> declaration +line 1 column 8 - Warning: discarding unexpected </i> +line 2 column 1 - Error: <bogustag> is not recognized! +line 2 column 1 - Warning: discarding unexpected <bogustag> +line 2 column 16 - Warning: discarding unexpected </bogustag> +line 1 column 1 - Warning: inserting missing 'title' element +]]> + </screen> + </example> + </para> + <para> + See also <function>tidy_access_count</function> and + <function>tidy_warning_count</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-reset-config.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/tidy/functions/tidy-reset-config.xml diff -u phpdoc/en/reference/tidy/functions/tidy-reset-config.xml:1.2 phpdoc/en/reference/tidy/functions/tidy-reset-config.xml:1.3 --- phpdoc/en/reference/tidy/functions/tidy-reset-config.xml:1.2 Sun Jan 18 10:11:07 2004 +++ phpdoc/en/reference/tidy/functions/tidy-reset-config.xml Wed Mar 3 13:24:08 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.tidy-reset-config"> <refnamediv> <refname>tidy_reset_config</refname> @@ -10,7 +10,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>string</type><methodname>tidy_reset_config</methodname> + <type>bool</type><methodname>tidy_reset_config</methodname> <void/> </methodsynopsis> &warn.undocumented.func; http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-save-config.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/tidy/functions/tidy-save-config.xml diff -u phpdoc/en/reference/tidy/functions/tidy-save-config.xml:1.3 phpdoc/en/reference/tidy/functions/tidy-save-config.xml:1.4 --- phpdoc/en/reference/tidy/functions/tidy-save-config.xml:1.3 Sun Jan 18 10:11:07 2004 +++ phpdoc/en/reference/tidy/functions/tidy-save-config.xml Wed Mar 3 13:24:08 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.tidy-save-config"> <refnamediv> <refname>tidy_save_config</refname> @@ -13,7 +13,16 @@ <type>bool</type><methodname>tidy_save_config</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + <function>tidy_save_config</function> saves current settings to the + specified file. Only non-default values are written. + </para> + <para> + See also <function>tidy_get_config</function>, + <function>tidy_getopt</function>, + <function>tidy_reset_config</function> and + <function>tidy_setopt</function>. + </para> &note.tidy.1only; </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-setopt.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/tidy/functions/tidy-setopt.xml diff -u phpdoc/en/reference/tidy/functions/tidy-setopt.xml:1.3 phpdoc/en/reference/tidy/functions/tidy-setopt.xml:1.4 --- phpdoc/en/reference/tidy/functions/tidy-setopt.xml:1.3 Sun Jan 18 10:11:07 2004 +++ phpdoc/en/reference/tidy/functions/tidy-setopt.xml Wed Mar 3 13:24:08 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.tidy-setopt"> <refnamediv> <refname>tidy_setopt</refname> @@ -12,9 +12,34 @@ <methodsynopsis> <type>bool</type><methodname>tidy_setopt</methodname> <methodparam><type>string</type><parameter>option</parameter></methodparam> - <methodparam><type>mixed</type><parameter>newvalue</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + <function>tidy_setopt</function> updates the specified + <parameter>option</parameter> with a new <parameter>value</parameter>. + </para> + <para> + <example> + <title><function>tidy_setopt</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$html = '<p>test</i>'; + +$tidy = tidy_parse_string($html); + +tidy_setopt('indent', FALSE); +?> +]]> + </programlisting> + </example> + </para> + <para> + See also <function>tidy_getopt</function>, + <function>tidy_get_config</function>, + <function>tidy_reset_config</function> and + <function>tidy_save_config</function>. + </para> &note.tidy.1only; </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-warning-count.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/tidy/functions/tidy-warning-count.xml diff -u phpdoc/en/reference/tidy/functions/tidy-warning-count.xml:1.1 phpdoc/en/reference/tidy/functions/tidy-warning-count.xml:1.2 --- phpdoc/en/reference/tidy/functions/tidy-warning-count.xml:1.1 Tue Nov 4 08:26:55 2003 +++ phpdoc/en/reference/tidy/functions/tidy-warning-count.xml Wed Mar 3 13:24:08 2004 @@ -1,6 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.tidy-warning-count"> <refnamediv> <refname>tidy_warning_count</refname> @@ -12,11 +11,34 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>tidy_warning_count</methodname> - <void/> + <methodparam><type>resource</type><parameter>tidy</parameter></methodparam> </methodsynopsis> + <para> + <function>tidy_warning_count</function> returns the number of Tidy warnings + encountered for the specified document. + </para> + <para> + <example> + <title><function>tidy_warning_count</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$html = '<p>test</i> +<bogustag>bogus</bogustag>'; - &warn.undocumented.func; +$tidy = tidy_parse_string($html); +echo tidy_error_count($tidy) . "\n"; //1 +echo tidy_warning_count($tidy) . "\n"; //5 +?> +]]> + </programlisting> + </example> + </para> + <para> + See also <function>tidy_access_count</function> and + <function>tidy_error_count</function>. + </para> </refsect1> </refentry>