[PHP-DOC] cvs: phpdoc /en/reference/tidy/functions tidy-get-error-buffer.xml tidy-get-html-ver.xml

[Nuno Lopes]

nlopess         Sat Mar  6 06:54:32 2004 EDT

  Modified files:              
    /phpdoc/en/reference/tidy/functions tidy-get-error-buffer.xml 
                                        tidy-get-html-ver.xml 
  Log:
  more tidy docs
  
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-get-error-buffer.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-get-error-buffer.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-get-error-buffer.xml:1.3 
phpdoc/en/reference/tidy/functions/tidy-get-error-buffer.xml:1.4
--- phpdoc/en/reference/tidy/functions/tidy-get-error-buffer.xml:1.3    Fri Dec 19 
10:49:59 2003
+++ phpdoc/en/reference/tidy/functions/tidy-get-error-buffer.xml        Sat Mar  6 
06:54:32 2004
@@ -1,6 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.3 $ -->
-<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
+<!-- $Revision: 1.4 $ -->
   <refentry id="function.tidy-get-error-buffer">
    <refnamediv>
     <refname>tidy_get_error_buffer</refname>
@@ -12,11 +11,41 @@
     <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>tidy_get_error_buffer</methodname>
-     <methodparam 
choice="opt"><type>bool</type><parameter>detailed</parameter></methodparam>
+     <methodparam><type>resource</type><parameter>tidy</parameter></methodparam>
     </methodsynopsis>
+    <para>
+     <function>tidy_get_error_buffer</function> returns warnings and errors
+     which occurred parsing the specified document.
+    </para>
+    <para>
+     <example>
+      <title><function>tidy_get_error_buffer</function> example</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+$html = '<p>paragraph</p>';
 
-     &warn.undocumented.func;
-
+$tidy = tidy_parse_string($html);
+echo tidy_get_error_buffer($tidy);
+?>
+]]>
+      </programlisting>
+      <para>
+       The above example will output:
+      </para>
+      <screen>
+<![CDATA[
+line 1 column 1 - Warning: missing <!DOCTYPE> declaration
+line 1 column 1 - Warning: inserting missing 'title' element
+]]>
+      </screen>
+     </example>
+    </para>
+    <para>
+     See also <function>tidy_access_count</function>,
+     <function>tidy_error_count</function> and
+     <function>tidy_warning_count</function>.
+    </para>
    </refsect1>
   </refentry>
 
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-get-html-ver.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-get-html-ver.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-get-html-ver.xml:1.1 
phpdoc/en/reference/tidy/functions/tidy-get-html-ver.xml:1.2
--- phpdoc/en/reference/tidy/functions/tidy-get-html-ver.xml:1.1        Tue Nov  4 
08:26:55 2003
+++ phpdoc/en/reference/tidy/functions/tidy-get-html-ver.xml    Sat Mar  6 06:54:32 
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-get-html-ver">
    <refnamediv>
     <refname>tidy_get_html_ver</refname>
@@ -12,7 +11,7 @@
     <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>tidy_get_html_ver</methodname>
-     <void/>
+     <methodparam><type>resource</type><parameter>tidy</parameter></methodparam>
     </methodsynopsis>
 
      &warn.undocumented.func;