[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/tidy/_functions/tidy-access-count.xml_functions/
From: Christoph_Michael_Becker <cmb () php ! net>
Date: 2020-11-29 23:31:19
Message-ID: svn-cmb-1606692679-351752-1009357050 () svn ! php ! net
[Download RAW message or body]
cmb Sun, 29 Nov 2020 23:31:19 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=351752
Log:
Generate tidy methodsynopses based on stubs
Closes GH-234.
Changed paths:
U phpdoc/en/trunk/reference/tidy/functions/tidy-access-count.xml
U phpdoc/en/trunk/reference/tidy/functions/tidy-config-count.xml
U phpdoc/en/trunk/reference/tidy/functions/tidy-error-count.xml
U phpdoc/en/trunk/reference/tidy/functions/tidy-get-output.xml
U phpdoc/en/trunk/reference/tidy/functions/tidy-warning-count.xml
U phpdoc/en/trunk/reference/tidy/tidy/body.xml
U phpdoc/en/trunk/reference/tidy/tidy/cleanrepair.xml
U phpdoc/en/trunk/reference/tidy/tidy/construct.xml
U phpdoc/en/trunk/reference/tidy/tidy/diagnose.xml
U phpdoc/en/trunk/reference/tidy/tidy/errorbuffer.xml
U phpdoc/en/trunk/reference/tidy/tidy/getconfig.xml
U phpdoc/en/trunk/reference/tidy/tidy/gethtmlver.xml
U phpdoc/en/trunk/reference/tidy/tidy/getopt.xml
U phpdoc/en/trunk/reference/tidy/tidy/getoptdoc.xml
U phpdoc/en/trunk/reference/tidy/tidy/getrelease.xml
U phpdoc/en/trunk/reference/tidy/tidy/getstatus.xml
U phpdoc/en/trunk/reference/tidy/tidy/head.xml
U phpdoc/en/trunk/reference/tidy/tidy/html.xml
U phpdoc/en/trunk/reference/tidy/tidy/isxhtml.xml
U phpdoc/en/trunk/reference/tidy/tidy/isxml.xml
U phpdoc/en/trunk/reference/tidy/tidy/parsefile.xml
U phpdoc/en/trunk/reference/tidy/tidy/parsestring.xml
U phpdoc/en/trunk/reference/tidy/tidy/repairfile.xml
U phpdoc/en/trunk/reference/tidy/tidy/repairstring.xml
U phpdoc/en/trunk/reference/tidy/tidy/root.xml
U phpdoc/en/trunk/reference/tidy/tidy.xml
U phpdoc/en/trunk/reference/tidy/tidynode/getparent.xml
["svn-diffs-351752.txt" (text/x-diff)]
Modified: phpdoc/en/trunk/reference/tidy/functions/tidy-access-count.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/functions/tidy-access-count.xml 2020-11-29 \
18:35:47 UTC (rev 351751)
+++ phpdoc/en/trunk/reference/tidy/functions/tidy-access-count.xml 2020-11-29 \
23:31:19 UTC (rev 351752) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>tidy_access_count</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_access_count</function> returns the number of
@@ -21,7 +21,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -95,7 +95,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/functions/tidy-config-count.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/functions/tidy-config-count.xml 2020-11-29 \
18:35:47 UTC (rev 351751)
+++ phpdoc/en/trunk/reference/tidy/functions/tidy-config-count.xml 2020-11-29 \
23:31:19 UTC (rev 351752) @@ -9,11 +9,11 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>tidy_config_count</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of errors encountered in the configuration of the
- specified tidy <parameter>object</parameter>.
+ specified tidy <parameter>tidy</parameter>.
</para>
</refsect1>
@@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -63,7 +63,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/functions/tidy-error-count.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/functions/tidy-error-count.xml 2020-11-29 18:35:47 \
UTC (rev 351751)
+++ phpdoc/en/trunk/reference/tidy/functions/tidy-error-count.xml 2020-11-29 23:31:19 \
UTC (rev 351752) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>tidy_error_count</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of Tidy errors encountered for the specified document.
@@ -21,7 +21,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -82,7 +82,6 @@
</simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/functions/tidy-get-output.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/functions/tidy-get-output.xml 2020-11-29 18:35:47 \
UTC (rev 351751)
+++ phpdoc/en/trunk/reference/tidy/functions/tidy-get-output.xml 2020-11-29 23:31:19 \
UTC (rev 351752) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>tidy_get_output</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
Gets a string with the repaired html.
@@ -20,7 +20,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -72,7 +72,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/functions/tidy-warning-count.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/functions/tidy-warning-count.xml 2020-11-29 \
18:35:47 UTC (rev 351751)
+++ phpdoc/en/trunk/reference/tidy/functions/tidy-warning-count.xml 2020-11-29 \
23:31:19 UTC (rev 351752) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>tidy_warning_count</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of Tidy warnings encountered for the specified document.
@@ -20,7 +20,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -67,7 +67,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/body.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/body.xml 2020-11-29 18:35:47 UTC (rev 351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/body.xml 2020-11-29 23:31:19 UTC (rev 351752)
@@ -9,14 +9,14 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
- <modifier>public</modifier> \
<type>tidyNode</type><methodname>tidy::body</methodname>
- <void />
+ <methodsynopsis role="oop">
+ <modifier>public</modifier> <type \
class="union"><type>tidyNode</type><type>null</type></type><methodname>tidy::body</methodname>
+ <void/>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
- <type>tidyNode</type><methodname>tidy_get_body</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodsynopsis role="procedural">
+ <type class="union"><type>tidyNode</type><type>null</type></type><methodname>tidy_get_body</methodname>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
Returns a <classname>tidyNode</classname> object starting from the
@@ -29,7 +29,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -94,7 +94,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/cleanrepair.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/cleanrepair.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/cleanrepair.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -9,18 +9,18 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
+ <methodsynopsis role="oop">
<modifier>public</modifier> \
<type>bool</type><methodname>tidy::cleanRepair</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
+ <methodsynopsis role="procedural">
<type>bool</type><methodname>tidy_clean_repair</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
This function cleans and repairs the given tidy
- <parameter>object</parameter>.
+ <parameter>tidy</parameter>.
</para>
</refsect1>
@@ -29,7 +29,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -90,7 +90,6 @@
</simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/construct.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/construct.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="tidy.construct" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> +<refentry xml:id="tidy.construct" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>tidy::__construct</refname>
<refpurpose>Constructs a new <classname>tidy</classname> object</refpurpose>
@@ -7,13 +7,13 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
- <methodsynopsis>
+ <constructorsynopsis>
<modifier>public</modifier> <methodname>tidy::__construct</methodname>
- <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
- <methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
- <methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam>
- </methodsynopsis>
+ <methodparam choice="opt"><type \
class="union"><type>string</type><type>null</type></type><parameter>filename</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>array</type><type>string</type><type>null</type></type><parameter>config</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type>bool</type><parameter>useIncludePath</parameter><initializer>&false;</initializer></methodparam>
+ </constructorsynopsis>
<para>
Constructs a new <classname>tidy</classname> object.
</para>
@@ -63,7 +63,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>use_include_path</parameter></term>
+ <term><parameter>useIncludePath</parameter></term>
<listitem>
<para>
Search for the file in the <link \
linkend="ini.include-path">include_path</link>. @@ -81,6 +81,29 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ <parameter>filename</parameter>, <parameter>config</parameter>,
+ <parameter>encoding</parameter> and <parameter>useIncludePath</parameter> are \
nullable now. + </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -138,7 +161,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/diagnose.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/diagnose.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/diagnose.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -9,17 +9,17 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
+ <methodsynopsis role="oop">
<modifier>public</modifier> \
<type>bool</type><methodname>tidy::diagnose</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
+ <methodsynopsis role="procedural">
<type>bool</type><methodname>tidy_diagnose</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
- Runs diagnostic tests on the given tidy <parameter>object</parameter>,
+ Runs diagnostic tests on the given tidy <parameter>tidy</parameter>,
adding some more information about the document in the error buffer.
</para>
</refsect1>
@@ -29,7 +29,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -99,7 +99,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/errorbuffer.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/errorbuffer.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/errorbuffer.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -9,10 +9,10 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (property):</para>
- <fieldsynopsis><modifier>public</modifier> <type>string</type><varname \
linkend="tidy.props.errorbuffer">tidy->errorBuffer</varname></fieldsynopsis> + \
<fieldsynopsis><modifier>public</modifier> <type>string</type><varname \
linkend="tidy.props.errorbuffer">tidy->errorBuffer</varname></fieldsynopsis> \
<para>&style.procedural;:</para>
- <methodsynopsis role="procedural">
- <type>string</type><methodname>tidy_get_error_buffer</methodname>
+ <methodsynopsis>
+ <type class="union"><type>string</type><type>false</type></type><methodname>tidy_get_error_buffer</methodname>
<methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
@@ -39,7 +39,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns the error buffer as a string.
+ Returns the error buffer as a string, or &false; if the buffer is empty.
</para>
</refsect1>
@@ -81,7 +81,6 @@
</simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/getconfig.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/getconfig.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/getconfig.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -9,18 +9,18 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
+ <methodsynopsis role="oop">
<modifier>public</modifier> \
<type>array</type><methodname>tidy::getConfig</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
+ <methodsynopsis role="procedural">
<type>array</type><methodname>tidy_get_config</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
Gets the list of the configuration options in use by the given tidy
- <parameter>object</parameter>.
+ <parameter>tidy</parameter>.
</para>
</refsect1>
@@ -29,7 +29,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -173,7 +173,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/gethtmlver.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/gethtmlver.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/gethtmlver.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -9,18 +9,18 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
+ <methodsynopsis role="oop">
<modifier>public</modifier> \
<type>int</type><methodname>tidy::getHtmlVer</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
+ <methodsynopsis role="procedural">
<type>int</type><methodname>tidy_get_html_ver</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
Returns the detected HTML version for the specified tidy
- <parameter>object</parameter>.
+ <parameter>tidy</parameter>.
</para>
</refsect1>
@@ -29,7 +29,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -54,7 +54,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/getopt.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/getopt.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/getopt.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -9,19 +9,19 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
- <modifier>public</modifier> \
<type>mixed</type><methodname>tidy::getOpt</methodname> + <methodsynopsis \
role="oop"> + <modifier>public</modifier> <type \
class="union"><type>string</type><type>int</type><type>bool</type></type><methodname>tidy::getOpt</methodname>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
- <type>mixed</type><methodname>tidy_getopt</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodsynopsis role="procedural">
+ <type class="union"><type>string</type><type>int</type><type>bool</type></type><methodname>tidy_getopt</methodname>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>
Returns the value of the specified <parameter>option</parameter> for the
- specified tidy <parameter>object</parameter>.
+ specified tidy <parameter>tidy</parameter>.
</para>
</refsect1>
@@ -30,7 +30,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -101,7 +101,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/getoptdoc.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/getoptdoc.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/getoptdoc.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -11,15 +11,15 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
- <modifier>public</modifier> \
<type>string</type><methodname>tidy::getOptDoc</methodname>
- <methodparam><type>string</type><parameter>optname</parameter></methodparam>
+ <methodsynopsis role="oop">
+ <modifier>public</modifier> <type \
class="union"><type>string</type><type>false</type></type><methodname>tidy::getOptDoc</methodname>
+ <methodparam><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
- <type>string</type><methodname>tidy_get_opt_doc</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
- <methodparam><type>string</type><parameter>optname</parameter></methodparam>
+ <methodsynopsis role="procedural">
+ <type class="union"><type>string</type><type>false</type></type><methodname>tidy_get_opt_doc</methodname>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
+ <methodparam><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_get_opt_doc</function> returns the documentation for the
@@ -38,7 +38,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -46,7 +46,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>optname</parameter></term>
+ <term><parameter>option</parameter></term>
<listitem>
<para>
The option name
@@ -108,7 +108,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/getrelease.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/getrelease.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/getrelease.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -9,12 +9,12 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
+ <methodsynopsis role="oop">
<modifier>public</modifier> \
<type>string</type><methodname>tidy::getRelease</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
+ <methodsynopsis role="procedural">
<type>string</type><methodname>tidy_get_release</methodname>
<void/>
</methodsynopsis>
@@ -31,7 +31,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/getstatus.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/getstatus.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/getstatus.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -9,17 +9,17 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
+ <methodsynopsis role="oop">
<modifier>public</modifier> \
<type>int</type><methodname>tidy::getStatus</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
+ <methodsynopsis role="procedural">
<type>int</type><methodname>tidy_get_status</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
- Returns the status for the specified tidy <parameter>object</parameter>.
+ Returns the status for the specified tidy <parameter>tidy</parameter>.
</para>
</refsect1>
@@ -28,7 +28,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -73,7 +73,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/head.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/head.xml 2020-11-29 18:35:47 UTC (rev 351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/head.xml 2020-11-29 23:31:19 UTC (rev 351752)
@@ -9,14 +9,14 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
- <modifier>public</modifier> \
<type>tidyNode</type><methodname>tidy::head</methodname>
- <void />
+ <methodsynopsis role="oop">
+ <modifier>public</modifier> <type \
class="union"><type>tidyNode</type><type>null</type></type><methodname>tidy::head</methodname>
+ <void/>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
- <type>tidyNode</type><methodname>tidy_get_head</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodsynopsis role="procedural">
+ <type class="union"><type>tidyNode</type><type>null</type></type><methodname>tidy_get_head</methodname>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
Returns a <classname>tidyNode</classname> object starting from
@@ -29,7 +29,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -93,7 +93,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/html.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/html.xml 2020-11-29 18:35:47 UTC (rev 351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/html.xml 2020-11-29 23:31:19 UTC (rev 351752)
@@ -9,14 +9,14 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
- <modifier>public</modifier> \
<type>tidyNode</type><methodname>tidy::html</methodname>
- <void />
+ <methodsynopsis role="oop">
+ <modifier>public</modifier> <type \
class="union"><type>tidyNode</type><type>null</type></type><methodname>tidy::html</methodname>
+ <void/>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
- <type>tidyNode</type><methodname>tidy_get_html</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodsynopsis role="procedural">
+ <type class="union"><type>tidyNode</type><type>null</type></type><methodname>tidy_get_html</methodname>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
Returns a <classname>tidyNode</classname> object starting
@@ -29,7 +29,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -97,7 +97,6 @@
</simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/isxhtml.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/isxhtml.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/isxhtml.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -9,14 +9,14 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
+ <methodsynopsis role="oop">
<modifier>public</modifier> \
<type>bool</type><methodname>tidy::isXhtml</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
+ <methodsynopsis role="procedural">
<type>bool</type><methodname>tidy_is_xhtml</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
Tells if the document is a XHTML document.
@@ -28,7 +28,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -43,7 +43,7 @@
&reftitle.returnvalues;
<para>
This function returns &true; if the specified tidy
- <parameter>object</parameter> is a XHTML document, or &false; otherwise.
+ <parameter>tidy</parameter> is a XHTML document, or &false; otherwise.
</para>
<warning>
<para>
@@ -54,7 +54,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/isxml.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/isxml.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/isxml.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -9,14 +9,14 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
+ <methodsynopsis role="oop">
<modifier>public</modifier> <type>bool</type><methodname>tidy::isXml</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
+ <methodsynopsis role="procedural">
<type>bool</type><methodname>tidy_is_xml</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
Tells if the document is a generic (non HTML/XHTML) XML document.
@@ -28,7 +28,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -43,7 +43,7 @@
&reftitle.returnvalues;
<para>
This function returns &true; if the specified tidy
- <parameter>object</parameter> is a generic XML document (non HTML/XHTML),
+ <parameter>tidy</parameter> is a generic XML document (non HTML/XHTML),
or &false; otherwise.
</para>
<warning>
@@ -55,7 +55,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/parsefile.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/parsefile.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/parsefile.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="tidy.parsefile" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> +<refentry xml:id="tidy.parsefile" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>tidy::parseFile</refname>
<refname>tidy_parse_file</refname>
@@ -12,17 +12,17 @@
<methodsynopsis>
<modifier>public</modifier> \
<type>bool</type><methodname>tidy::parseFile</methodname> \
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
- <methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
- <methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter><initializer>&false;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>array</type><type>string</type><type>null</type></type><parameter>config</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type>bool</type><parameter>useIncludePath</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
- <type>tidy</type><methodname>tidy_parse_file</methodname>
+ <type class="union"><type>tidy</type><type>false</type></type><methodname>tidy_parse_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
- <methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
- <methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter><initializer>&false;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>array</type><type>string</type><type>null</type></type><parameter>config</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type>bool</type><parameter>useIncludePath</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Parses the given file.
@@ -73,7 +73,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>use_include_path</parameter></term>
+ <term><parameter>useIncludePath</parameter></term>
<listitem>
<para>
Search for the file in the <link \
linkend="ini.include-path">include_path</link>. @@ -87,10 +87,35 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &return.success;
+ <methodname>tidy::parseFile</methodname> returns &true; on success.
+ <function>tidy_parse_file</function> returns a new <classname>tidy</classname>
+ instance on success.
+ Both, the method and the function return &false; on failure.
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ <parameter>config</parameter> and <parameter>encoding</parameter> are \
nullable now. + </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -125,7 +150,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/parsestring.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/parsestring.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/parsestring.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="tidy.parsestring" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> +<refentry xml:id="tidy.parsestring" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>tidy::parseString</refname>
<refname>tidy_parse_string</refname>
@@ -11,16 +11,16 @@
<para>&style.oop;</para>
<methodsynopsis>
<modifier>public</modifier> \
<type>bool</type><methodname>tidy::parseString</methodname>
- <methodparam><type>string</type><parameter>input</parameter></methodparam>
- <methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
+ <methodparam><type>string</type><parameter>string</parameter></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>array</type><type>string</type><type>null</type></type><parameter>config</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
- <type>tidy</type><methodname>tidy_parse_string</methodname>
- <methodparam><type>string</type><parameter>input</parameter></methodparam>
- <methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
+ <type class="union"><type>tidy</type><type>false</type></type><methodname>tidy_parse_string</methodname>
+ <methodparam><type>string</type><parameter>string</parameter></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>array</type><type>string</type><type>null</type></type><parameter>config</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Parses a document stored in a string.
@@ -32,7 +32,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>input</parameter></term>
+ <term><parameter>string</parameter></term>
<listitem>
<para>
The data to be parsed.
@@ -75,10 +75,35 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns a new <classname>tidy</classname> instance.
+ <methodname>tidy::parseString</methodname> returns &true; on success.
+ <function>tidy_parse_srting</function> returns a new <classname>tidy</classname>
+ instance on success.
+ Both, the method and the function return &false; on failure.
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ <parameter>config</parameter> and <parameter>encoding</parameter> are \
nullable now. + </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -147,7 +172,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/repairfile.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/repairfile.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/repairfile.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -9,20 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
- <modifier>public</modifier> \
<type>string</type><methodname>tidy::repairFile</methodname> + <methodsynopsis \
role="oop"> + <modifier>public</modifier> <modifier>static</modifier> <type \
class="union"><type>string</type><type>false</type></type><methodname>tidy::repairFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
- <methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
- <methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter><initializer>&false;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>array</type><type>string</type><type>null</type></type><parameter>config</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type>bool</type><parameter>useIncludePath</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
- <type>string</type><methodname>tidy_repair_file</methodname>
+ <methodsynopsis role="procedural">
+ <type class="union"><type>string</type><type>false</type></type><methodname>tidy_repair_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
- <methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
- <methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter><initializer>&false;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>array</type><type>string</type><type>null</type></type><parameter>config</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type>bool</type><parameter>useIncludePath</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
@@ -72,7 +72,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>use_include_path</parameter></term>
+ <term><parameter>useIncludePath</parameter></term>
<listitem>
<para>
Search for the file in the <link \
linkend="ini.include-path">include_path</link>. @@ -86,10 +86,38 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns the repaired contents as a string.
+ Returns the repaired contents as a string, &return.falseforfailure;.
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ <methodname>tidy::repairFile</methodname> is a static method now.
+ </entry>
+ </row>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ <parameter>config</parameter> and <parameter>encoding</parameter> are \
nullable now. + </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -122,7 +150,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/repairstring.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/repairstring.xml 2020-11-29 18:35:47 UTC (rev \
351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/repairstring.xml 2020-11-29 23:31:19 UTC (rev \
351752) @@ -9,18 +9,18 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
- <modifier>public</modifier> \
<type>string</type><methodname>tidy::repairString</methodname>
- <methodparam><type>string</type><parameter>data</parameter></methodparam>
- <methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
+ <methodsynopsis role="oop">
+ <modifier>public</modifier> <modifier>static</modifier> <type \
class="union"><type>string</type><type>false</type></type><methodname>tidy::repairString</methodname>
+ <methodparam><type>string</type><parameter>string</parameter></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>array</type><type>string</type><type>null</type></type><parameter>config</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
- <type>string</type><methodname>tidy_repair_string</methodname>
- <methodparam><type>string</type><parameter>data</parameter></methodparam>
- <methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
+ <methodsynopsis role="procedural">
+ <type class="union"><type>string</type><type>false</type></type><methodname>tidy_repair_string</methodname>
+ <methodparam><type>string</type><parameter>string</parameter></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>array</type><type>string</type><type>null</type></type><parameter>config</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type \
class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Repairs the given string.
@@ -32,7 +32,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>data</parameter></term>
+ <term><parameter>string</parameter></term>
<listitem>
<para>
The data to be repaired.
@@ -75,10 +75,44 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns the repaired string.
+ Returns the repaired string, &return.falseforfailure;.
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ <methodname>tidy::repairString</methodname> is a static method now.
+ </entry>
+ </row>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ <parameter>config</parameter> and <parameter>encoding</parameter> are \
nullable now. + </entry>
+ </row>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ This function no longer accepts the <parameter>useIncludePath</parameter> \
parameter. + </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -136,7 +170,6 @@
</simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy/root.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy/root.xml 2020-11-29 18:35:47 UTC (rev 351751)
+++ phpdoc/en/trunk/reference/tidy/tidy/root.xml 2020-11-29 23:31:19 UTC (rev 351752)
@@ -9,14 +9,14 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
- <methodsynopsis>
- <modifier>public</modifier> \
<type>tidyNode</type><methodname>tidy::root</methodname>
- <void />
+ <methodsynopsis role="oop">
+ <modifier>public</modifier> <type \
class="union"><type>tidyNode</type><type>null</type></type><methodname>tidy::root</methodname>
+ <void/>
</methodsynopsis>
<para>&style.procedural;</para>
- <methodsynopsis>
- <type>tidyNode</type><methodname>tidy_get_root</methodname>
- <methodparam><type>tidy</type><parameter>object</parameter></methodparam>
+ <methodsynopsis role="procedural">
+ <type class="union"><type>tidyNode</type><type>null</type></type><methodname>tidy_get_root</methodname>
+ <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
<para>
Returns a <classname>tidyNode</classname> object representing the
@@ -29,7 +29,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>object</parameter></term>
+ <term><parameter>tidy</parameter></term>
<listitem>
<para>
&tidy.object;
@@ -99,7 +99,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/tidy/tidy.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidy.xml 2020-11-29 18:35:47 UTC (rev 351751)
+++ phpdoc/en/trunk/reference/tidy/tidy.xml 2020-11-29 23:31:19 UTC (rev 351752)
@@ -33,6 +33,9 @@
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) \
xpointer(id('class.tidy')/db:refentry/db:refsect1[@role='description']/descendant::db:fieldsynopsis[1])" \
/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) \
xpointer(id('class.tidy')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
+ <xi:fallback />
+ </xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) \
xpointer(id('class.tidy')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')][1])" \
/>
</classsynopsis>
Modified: phpdoc/en/trunk/reference/tidy/tidynode/getparent.xml
===================================================================
--- phpdoc/en/trunk/reference/tidy/tidynode/getparent.xml 2020-11-29 18:35:47 UTC \
(rev 351751)
+++ phpdoc/en/trunk/reference/tidy/tidynode/getparent.xml 2020-11-29 23:31:19 UTC \
(rev 351752) @@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> \
<type>tidyNode</type><methodname>tidyNode::getParent</methodname> + \
<modifier>public</modifier> <type \
class="union"><type>tidyNode</type><type>null</type></type><methodname>tidyNode::getParent</methodname>
<void/>
</methodsynopsis>
<para>
@@ -70,7 +70,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic