nlopess Sat Feb 21 05:41:02 2004 EDT
Modified files:
/phpdoc/en/reference/tidy/functions tidy-access-count.xml
tidy-clean-repair.xml
tidy-config-count.xml
Log:
some more tidy documentation and examples
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-access-count.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-access-count.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-access-count.xml:1.1
phpdoc/en/reference/tidy/functions/tidy-access-count.xml:1.2
--- phpdoc/en/reference/tidy/functions/tidy-access-count.xml:1.1 Tue Nov 4
08:26:55 2003
+++ phpdoc/en/reference/tidy/functions/tidy-access-count.xml Sat Feb 21 05:41:02
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-access-count">
<refnamediv>
<refname>tidy_access_count</refname>
@@ -12,7 +11,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>tidy_access_count</methodname>
- <void/>
+ <methodparam><type>resource</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-clean-repair.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-clean-repair.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-clean-repair.xml:1.2
phpdoc/en/reference/tidy/functions/tidy-clean-repair.xml:1.3
--- phpdoc/en/reference/tidy/functions/tidy-clean-repair.xml:1.2 Thu Nov 6
05:15:42 2003
+++ phpdoc/en/reference/tidy/functions/tidy-clean-repair.xml Sat Feb 21 05:41:02
2004
@@ -1,6 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.2 $ -->
-<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.tidy-clean-repair">
<refnamediv>
<refname>tidy_clean_repair</refname>
@@ -12,11 +11,49 @@
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidy_clean_repair</methodname>
- <void/>
+ <methodparam><type>resource</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
+ <para>
+ This function cleans and repairs the given <parameter>tidy</parameter>
+ resource.
+ </para>
+ <para>
+ <example>
+ <title><function>tidy_clean_repair</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$html = '<p>test</I>';
- &warn.undocumented.func;
+$tidy = tidy_parse_string($html);
+tidy_clean_repair($tidy);
+echo $tidy;
+?>
+]]>
+ </programlisting>
+ <para>
+ The above example will output:
+ </para>
+ <screen>
+<![CDATA[
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
+<html>
+<head>
+<title></title>
+</head>
+<body>
+<p>test</p>
+</body>
+</html>
+]]>
+ </screen>
+ </example>
+ </para>
+ <para>
+ See also <function>tidy_repair_file</function> and
+ <function>tidy_repair_string</function>.
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-config-count.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-config-count.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-config-count.xml:1.1
phpdoc/en/reference/tidy/functions/tidy-config-count.xml:1.2
--- phpdoc/en/reference/tidy/functions/tidy-config-count.xml:1.1 Tue Nov 4
08:26:55 2003
+++ phpdoc/en/reference/tidy/functions/tidy-config-count.xml Sat Feb 21 05:41:02
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-config-count">
<refnamediv>
<refname>tidy_config_count</refname>
@@ -12,11 +11,30 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>tidy_config_count</methodname>
- <void/>
+ <methodparam><type>resource</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
+ <para>
+ <function>tidy_config_count</function> returns the number of errors
+ encountered in the given configuration.
+ </para>
+ <para>
+ <example>
+ <title><function>tidy_config_count</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$html = '<p>test</I>';
- &warn.undocumented.func;
+$config = array('foo' => 'bar');
+$tidy = tidy_parse_string($html, $config);
+
+echo tidy_config_count($tidy); //1
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
</refsect1>
</refentry>
