From 51dbae9fc36388c9ad3461b3364d50cbda5f38ae Mon Sep 17 00:00:00 2001
From: Nuno Lopes <nlopess@php.net>
Date: Sat, 21 Feb 2004 10:41:02 +0000
Subject: [PATCH] some more tidy documentation and examples

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@151991 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../tidy/functions/tidy-access-count.xml      |  5 +--
 .../tidy/functions/tidy-clean-repair.xml      | 45 +++++++++++++++++--
 .../tidy/functions/tidy-config-count.xml      | 26 +++++++++--
 3 files changed, 65 insertions(+), 11 deletions(-)
diff --git a/reference/tidy/functions/tidy-access-count.xml b/reference/tidy/functions/tidy-access-count.xml
index 6bb114a346..4a6953efab 100644
--- a/reference/tidy/functions/tidy-access-count.xml
+++ b/reference/tidy/functions/tidy-access-count.xml
@@ -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;
diff --git a/reference/tidy/functions/tidy-clean-repair.xml b/reference/tidy/functions/tidy-clean-repair.xml
index 53a751520a..a5c48c38cb 100644
--- a/reference/tidy/functions/tidy-clean-repair.xml
+++ b/reference/tidy/functions/tidy-clean-repair.xml
@@ -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>
 
diff --git a/reference/tidy/functions/tidy-config-count.xml b/reference/tidy/functions/tidy-config-count.xml
index 9cd647f0b0..c1538c08e2 100644
--- a/reference/tidy/functions/tidy-config-count.xml
+++ b/reference/tidy/functions/tidy-config-count.xml
@@ -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>
 
