From 97b2f255267b9e416753257805051d2636e871c6 Mon Sep 17 00:00:00 2001
From: Nuno Lopes <nlopess@php.net>
Date: Mon, 19 Jan 2004 19:59:16 +0000
Subject: [PATCH] added documentation and example

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@149253 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../tidy/functions/tidy-repair-string.xml     | 57 ++++++++++++++++++-
 1 file changed, 54 insertions(+), 3 deletions(-)
diff --git a/reference/tidy/functions/tidy-repair-string.xml b/reference/tidy/functions/tidy-repair-string.xml
index c5efc16622..5a62b556dd 100644
--- a/reference/tidy/functions/tidy-repair-string.xml
+++ b/reference/tidy/functions/tidy-repair-string.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-repair-string">
    <refnamediv>
     <refname>tidy_repair_string</refname>
@@ -14,10 +13,62 @@
      <type>bool</type><methodname>tidy_repair_string</methodname>
      <methodparam><type>string</type><parameter>data</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>config_file</parameter></methodparam>
+     <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
     </methodsynopsis>
+    <para>
+     This function repairs the given string.
+    </para>
+    <para>
+     <example>
+      <title><function>tidy_repair_string</function> example</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+ob_start();
+?>
 
-     &warn.undocumented.func;
+<html>
+  <head>
+    <title>test</title>
+  </head>
+  <body>
+    <p>error</i>
+  </body>
+</html>
 
+<?php
+
+$buffer = ob_get_clean();
+$tidy = tidy_repair_string($buffer);
+
+echo $tidy;
+?>
+]]>
+      </programlisting>
+      <para>
+       The above example will output:
+      </para>
+      <screen>
+<![CDATA[
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
+<html>
+<head>
+<title>test</title>
+</head>
+<body>
+<p>error</p>
+</body>
+</html>
+]]>
+      </screen>
+     </example>
+    </para>
+    <para>
+     See also <function>tidy_parse_file</function>,
+     <function>tidy_parse_string</function> and
+     <function>tidy_repair_file</function>.
+    </para>
+     &note.tidy.2only;
    </refsect1>
   </refentry>
 
