From 2744c429ab56c42e2868fd5afe985252595cec6a Mon Sep 17 00:00:00 2001 From: John Coggeshall Date: Tue, 4 Nov 2003 13:26:55 +0000 Subject: [PATCH] Added shell documentation for the tidy extension git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@143779 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../tidy/functions/tidy-access-count.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-clean-repair.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-config-count.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-diagnose.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-error-count.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-get-body.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-get-config.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-get-error-buffer.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-get-head.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-get-html-ver.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-get-html.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-get-output.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-get-release.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-get-root.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-get-status.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-getopt.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-is-xhtml.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-load-config.xml | 43 +++++++++++++++++ .../tidy/functions/tidy-node::attributes.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-node::children.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-node::get-attr.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-node::get-nodes.xml | 42 +++++++++++++++++ .../functions/tidy-node::has-children.xml | 42 +++++++++++++++++ .../functions/tidy-node::has-siblings.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-node::is-asp.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-node::is-comment.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-node::is-html.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-node::is-jsp.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-node::is-jste.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-node::is-text.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-node::is-xhtml.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-node::is-xml.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-node::next.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-node::prev.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-node::tidy-node.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-parse-file.xml | 43 +++++++++++++++++ .../tidy/functions/tidy-parse-string.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-repair-file.xml | 44 +++++++++++++++++ .../tidy/functions/tidy-repair-string.xml | 43 +++++++++++++++++ .../tidy/functions/tidy-reset-config.xml | 42 +++++++++++++++++ reference/tidy/functions/tidy-save-config.xml | 42 +++++++++++++++++ .../tidy/functions/tidy-set-encoding.xml | 44 +++++++++++++++++ reference/tidy/functions/tidy-setopt.xml | 43 +++++++++++++++++ .../tidy/functions/tidy-warning-count.xml | 42 +++++++++++++++++ reference/tidy/reference.xml | 47 +++++++++++++++++++ 45 files changed, 1903 insertions(+) create mode 100644 reference/tidy/functions/tidy-access-count.xml create mode 100644 reference/tidy/functions/tidy-clean-repair.xml create mode 100644 reference/tidy/functions/tidy-config-count.xml create mode 100644 reference/tidy/functions/tidy-diagnose.xml create mode 100644 reference/tidy/functions/tidy-error-count.xml create mode 100644 reference/tidy/functions/tidy-get-body.xml create mode 100644 reference/tidy/functions/tidy-get-config.xml create mode 100644 reference/tidy/functions/tidy-get-error-buffer.xml create mode 100644 reference/tidy/functions/tidy-get-head.xml create mode 100644 reference/tidy/functions/tidy-get-html-ver.xml create mode 100644 reference/tidy/functions/tidy-get-html.xml create mode 100644 reference/tidy/functions/tidy-get-output.xml create mode 100644 reference/tidy/functions/tidy-get-release.xml create mode 100644 reference/tidy/functions/tidy-get-root.xml create mode 100644 reference/tidy/functions/tidy-get-status.xml create mode 100644 reference/tidy/functions/tidy-getopt.xml create mode 100644 reference/tidy/functions/tidy-is-xhtml.xml create mode 100644 reference/tidy/functions/tidy-load-config.xml create mode 100644 reference/tidy/functions/tidy-node::attributes.xml create mode 100644 reference/tidy/functions/tidy-node::children.xml create mode 100644 reference/tidy/functions/tidy-node::get-attr.xml create mode 100644 reference/tidy/functions/tidy-node::get-nodes.xml create mode 100644 reference/tidy/functions/tidy-node::has-children.xml create mode 100644 reference/tidy/functions/tidy-node::has-siblings.xml create mode 100644 reference/tidy/functions/tidy-node::is-asp.xml create mode 100644 reference/tidy/functions/tidy-node::is-comment.xml create mode 100644 reference/tidy/functions/tidy-node::is-html.xml create mode 100644 reference/tidy/functions/tidy-node::is-jsp.xml create mode 100644 reference/tidy/functions/tidy-node::is-jste.xml create mode 100644 reference/tidy/functions/tidy-node::is-text.xml create mode 100644 reference/tidy/functions/tidy-node::is-xhtml.xml create mode 100644 reference/tidy/functions/tidy-node::is-xml.xml create mode 100644 reference/tidy/functions/tidy-node::next.xml create mode 100644 reference/tidy/functions/tidy-node::prev.xml create mode 100644 reference/tidy/functions/tidy-node::tidy-node.xml create mode 100644 reference/tidy/functions/tidy-parse-file.xml create mode 100644 reference/tidy/functions/tidy-parse-string.xml create mode 100644 reference/tidy/functions/tidy-repair-file.xml create mode 100644 reference/tidy/functions/tidy-repair-string.xml create mode 100644 reference/tidy/functions/tidy-reset-config.xml create mode 100644 reference/tidy/functions/tidy-save-config.xml create mode 100644 reference/tidy/functions/tidy-set-encoding.xml create mode 100644 reference/tidy/functions/tidy-setopt.xml create mode 100644 reference/tidy/functions/tidy-warning-count.xml create mode 100644 reference/tidy/reference.xml diff --git a/reference/tidy/functions/tidy-access-count.xml b/reference/tidy/functions/tidy-access-count.xml new file mode 100644 index 0000000000..6bb114a346 --- /dev/null +++ b/reference/tidy/functions/tidy-access-count.xml @@ -0,0 +1,42 @@ + + + + + + tidy_access_count + + Returns the Number of Tidy accessibility warnings encountered for specified document. + + + + Description + + inttidy_access_count + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-clean-repair.xml b/reference/tidy/functions/tidy-clean-repair.xml new file mode 100644 index 0000000000..afaed379fe --- /dev/null +++ b/reference/tidy/functions/tidy-clean-repair.xml @@ -0,0 +1,42 @@ + + + + + + tidy_clean_repair + + Execute configured cleanup and repair operations on parsed markup + + + + Description + + booleantidy_clean_repair + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-config-count.xml b/reference/tidy/functions/tidy-config-count.xml new file mode 100644 index 0000000000..9cd647f0b0 --- /dev/null +++ b/reference/tidy/functions/tidy-config-count.xml @@ -0,0 +1,42 @@ + + + + + + tidy_config_count + + Returns the Number of Tidy configuration errors encountered for specified document. + + + + Description + + inttidy_config_count + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-diagnose.xml b/reference/tidy/functions/tidy-diagnose.xml new file mode 100644 index 0000000000..41b78963a9 --- /dev/null +++ b/reference/tidy/functions/tidy-diagnose.xml @@ -0,0 +1,42 @@ + + + + + + tidy_diagnose + + Run configured diagnostics on parsed and repaired markup. + + + + Description + + booleantidy_diagnose + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-error-count.xml b/reference/tidy/functions/tidy-error-count.xml new file mode 100644 index 0000000000..5ab5009462 --- /dev/null +++ b/reference/tidy/functions/tidy-error-count.xml @@ -0,0 +1,42 @@ + + + + + + tidy_error_count + + Returns the Number of Tidy errors encountered for specified document. + + + + Description + + inttidy_error_count + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-get-body.xml b/reference/tidy/functions/tidy-get-body.xml new file mode 100644 index 0000000000..b46aba79fa --- /dev/null +++ b/reference/tidy/functions/tidy-get-body.xml @@ -0,0 +1,42 @@ + + + + + + tidy_get_body + + Returns a TidyNode Object starting from the tag of the tidy parse tree + + + + Description + + TidyNodetidy_get_body + resourcetidy + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-get-config.xml b/reference/tidy/functions/tidy-get-config.xml new file mode 100644 index 0000000000..b507142250 --- /dev/null +++ b/reference/tidy/functions/tidy-get-config.xml @@ -0,0 +1,42 @@ + + + + + + tidy_get_config + + Get current Tidy configuarion + + + + Description + + arraytidy_get_config + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-get-error-buffer.xml b/reference/tidy/functions/tidy-get-error-buffer.xml new file mode 100644 index 0000000000..1afc56c2d3 --- /dev/null +++ b/reference/tidy/functions/tidy-get-error-buffer.xml @@ -0,0 +1,42 @@ + + + + + + tidy_get_error_buffer + + Return warnings and errors which occured parsing the specified document + + + + Description + + stringtidy_get_error_buffer + booleandetailed + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-get-head.xml b/reference/tidy/functions/tidy-get-head.xml new file mode 100644 index 0000000000..6b36bd07b9 --- /dev/null +++ b/reference/tidy/functions/tidy-get-head.xml @@ -0,0 +1,42 @@ + + + + + + tidy_get_head + + Returns a TidyNode Object starting from the tag of the tidy parse tree + + + + Description + + TidyNodetidy_get_head + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-get-html-ver.xml b/reference/tidy/functions/tidy-get-html-ver.xml new file mode 100644 index 0000000000..6724c95fab --- /dev/null +++ b/reference/tidy/functions/tidy-get-html-ver.xml @@ -0,0 +1,42 @@ + + + + + + tidy_get_html_ver + + Get the Detected HTML version for the specified document. + + + + Description + + inttidy_get_html_ver + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-get-html.xml b/reference/tidy/functions/tidy-get-html.xml new file mode 100644 index 0000000000..7dc1be99c0 --- /dev/null +++ b/reference/tidy/functions/tidy-get-html.xml @@ -0,0 +1,42 @@ + + + + + + tidy_get_html + + Returns a TidyNode Object starting from the tag of the tidy parse tree + + + + Description + + TidyNodetidy_get_html + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-get-output.xml b/reference/tidy/functions/tidy-get-output.xml new file mode 100644 index 0000000000..40acd7ab80 --- /dev/null +++ b/reference/tidy/functions/tidy-get-output.xml @@ -0,0 +1,42 @@ + + + + + + tidy_get_output + + Return a string representing the parsed tidy markup + + + + Description + + stringtidy_get_output + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-get-release.xml b/reference/tidy/functions/tidy-get-release.xml new file mode 100644 index 0000000000..0d54061dac --- /dev/null +++ b/reference/tidy/functions/tidy-get-release.xml @@ -0,0 +1,42 @@ + + + + + + tidy_get_release + + Get release date (version) for Tidy library + + + + Description + + stringtidy_get_release + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-get-root.xml b/reference/tidy/functions/tidy-get-root.xml new file mode 100644 index 0000000000..f3fead82f6 --- /dev/null +++ b/reference/tidy/functions/tidy-get-root.xml @@ -0,0 +1,42 @@ + + + + + + tidy_get_root + + Returns a TidyNode Object representing the root of the tidy parse tree + + + + Description + + TidyNodetidy_get_root + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-get-status.xml b/reference/tidy/functions/tidy-get-status.xml new file mode 100644 index 0000000000..d112a8deff --- /dev/null +++ b/reference/tidy/functions/tidy-get-status.xml @@ -0,0 +1,42 @@ + + + + + + tidy_get_status + + Get status of specfied document. + + + + Description + + inttidy_get_status + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-getopt.xml b/reference/tidy/functions/tidy-getopt.xml new file mode 100644 index 0000000000..da0741760c --- /dev/null +++ b/reference/tidy/functions/tidy-getopt.xml @@ -0,0 +1,42 @@ + + + + + + tidy_getopt + + Returns the value of the specified configuration option for the tidy document. + + + + Description + + mixedtidy_getopt + stringoption + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-is-xhtml.xml b/reference/tidy/functions/tidy-is-xhtml.xml new file mode 100644 index 0000000000..483530b61e --- /dev/null +++ b/reference/tidy/functions/tidy-is-xhtml.xml @@ -0,0 +1,42 @@ + + + + + + tidy_is_xhtml + + Indicates if the document is a generic (non HTML/XHTML) XML document. + + + + Description + + booleantidy_is_xhtml + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-load-config.xml b/reference/tidy/functions/tidy-load-config.xml new file mode 100644 index 0000000000..e519df5cb4 --- /dev/null +++ b/reference/tidy/functions/tidy-load-config.xml @@ -0,0 +1,43 @@ + + + + + + tidy_load_config + + Load an ASCII Tidy configuration file with the specified encoding + + + + Description + + voidtidy_load_config + stringfilename + stringencoding + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::attributes.xml b/reference/tidy/functions/tidy-node::attributes.xml new file mode 100644 index 0000000000..096b11918a --- /dev/null +++ b/reference/tidy/functions/tidy-node::attributes.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::attributes + + Returns an array of attribute objects for node + + + + Description + + tidy_attrtidy_node::attributes + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::children.xml b/reference/tidy/functions/tidy-node::children.xml new file mode 100644 index 0000000000..74b3b1952d --- /dev/null +++ b/reference/tidy/functions/tidy-node::children.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::children + + Returns an array of child nodes + + + + Description + + tidy_nodetidy_node::children + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::get-attr.xml b/reference/tidy/functions/tidy-node::get-attr.xml new file mode 100644 index 0000000000..2aa2377342 --- /dev/null +++ b/reference/tidy/functions/tidy-node::get-attr.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::get_attr + + Return the attribute with the provided attribute id + + + + Description + + tidy_attrtidy_node::get_attr + intattrib_id + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::get-nodes.xml b/reference/tidy/functions/tidy-node::get-nodes.xml new file mode 100644 index 0000000000..383734d3d4 --- /dev/null +++ b/reference/tidy/functions/tidy-node::get-nodes.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::get_nodes + + Return an array of nodes under this node with the specified id + + + + Description + + tidy_nodetidy_node::get_nodes + intnode_id + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::has-children.xml b/reference/tidy/functions/tidy-node::has-children.xml new file mode 100644 index 0000000000..5eb77784b4 --- /dev/null +++ b/reference/tidy/functions/tidy-node::has-children.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::has_children + + Returns true if this node has children + + + + Description + + booleantidy_node::has_children + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::has-siblings.xml b/reference/tidy/functions/tidy-node::has-siblings.xml new file mode 100644 index 0000000000..a1936ff90a --- /dev/null +++ b/reference/tidy/functions/tidy-node::has-siblings.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::has_siblings + + Returns true if this node has siblings + + + + Description + + booleantidy_node::has_siblings + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::is-asp.xml b/reference/tidy/functions/tidy-node::is-asp.xml new file mode 100644 index 0000000000..d067e3f062 --- /dev/null +++ b/reference/tidy/functions/tidy-node::is-asp.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::is_asp + + Returns true if this node is ASP + + + + Description + + booleantidy_node::is_asp + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::is-comment.xml b/reference/tidy/functions/tidy-node::is-comment.xml new file mode 100644 index 0000000000..7e1523b725 --- /dev/null +++ b/reference/tidy/functions/tidy-node::is-comment.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::is_comment + + Returns true if this node represents a comment + + + + Description + + booleantidy_node::is_comment + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::is-html.xml b/reference/tidy/functions/tidy-node::is-html.xml new file mode 100644 index 0000000000..5473f2c153 --- /dev/null +++ b/reference/tidy/functions/tidy-node::is-html.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::is_html + + Returns true if this node is part of a HTML document + + + + Description + + booleantidy_node::is_html + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::is-jsp.xml b/reference/tidy/functions/tidy-node::is-jsp.xml new file mode 100644 index 0000000000..224c90ecfe --- /dev/null +++ b/reference/tidy/functions/tidy-node::is-jsp.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::is_jsp + + Returns true if this node is JSP + + + + Description + + booleantidy_node::is_jsp + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::is-jste.xml b/reference/tidy/functions/tidy-node::is-jste.xml new file mode 100644 index 0000000000..8879b8401a --- /dev/null +++ b/reference/tidy/functions/tidy-node::is-jste.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::is_jste + + Returns true if this node is JSTE + + + + Description + + booleantidy_node::is_jste + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::is-text.xml b/reference/tidy/functions/tidy-node::is-text.xml new file mode 100644 index 0000000000..7ef70ddcd5 --- /dev/null +++ b/reference/tidy/functions/tidy-node::is-text.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::is_text + + Returns true if this node represents text (no markup) + + + + Description + + booleantidy_node::is_text + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::is-xhtml.xml b/reference/tidy/functions/tidy-node::is-xhtml.xml new file mode 100644 index 0000000000..8d803d1e5a --- /dev/null +++ b/reference/tidy/functions/tidy-node::is-xhtml.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::is_xhtml + + Returns true if this node is part of a XHTML document + + + + Description + + booleantidy_node::is_xhtml + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::is-xml.xml b/reference/tidy/functions/tidy-node::is-xml.xml new file mode 100644 index 0000000000..3085a340dd --- /dev/null +++ b/reference/tidy/functions/tidy-node::is-xml.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::is_xml + + Returns true if this node is part of a XML document + + + + Description + + booleantidy_node::is_xml + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::next.xml b/reference/tidy/functions/tidy-node::next.xml new file mode 100644 index 0000000000..e43dd3855d --- /dev/null +++ b/reference/tidy/functions/tidy-node::next.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::next + + Returns the next sibling to this node + + + + Description + + tidy_nodetidy_node::next + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::prev.xml b/reference/tidy/functions/tidy-node::prev.xml new file mode 100644 index 0000000000..c8b4138a8f --- /dev/null +++ b/reference/tidy/functions/tidy-node::prev.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::prev + + Returns the previous sibiling to this node + + + + Description + + tidy_nodetidy_node::prev + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-node::tidy-node.xml b/reference/tidy/functions/tidy-node::tidy-node.xml new file mode 100644 index 0000000000..a630f7d483 --- /dev/null +++ b/reference/tidy/functions/tidy-node::tidy-node.xml @@ -0,0 +1,42 @@ + + + + + + tidy_node::tidy_node + + Constructor. + + + + Description + + voidtidy_node::tidy_node + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-parse-file.xml b/reference/tidy/functions/tidy-parse-file.xml new file mode 100644 index 0000000000..7b1831f655 --- /dev/null +++ b/reference/tidy/functions/tidy-parse-file.xml @@ -0,0 +1,43 @@ + + + + + + tidy_parse_file + + Parse markup in file or URI + + + + Description + + booleantidy_parse_file + stringfile + booluse_include_path + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-parse-string.xml b/reference/tidy/functions/tidy-parse-string.xml new file mode 100644 index 0000000000..8ed08dc2a1 --- /dev/null +++ b/reference/tidy/functions/tidy-parse-string.xml @@ -0,0 +1,42 @@ + + + + + + tidy_parse_string + + Parse a document stored in a string + + + + Description + + booltidy_parse_string + stringinput + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-repair-file.xml b/reference/tidy/functions/tidy-repair-file.xml new file mode 100644 index 0000000000..ffc36b19a9 --- /dev/null +++ b/reference/tidy/functions/tidy-repair-file.xml @@ -0,0 +1,44 @@ + + + + + + tidy_repair_file + + Repair a file using an optionally provided configuration file + + + + Description + + booleantidy_repair_file + stringfilename + stringconfig_file + booluse_include_path + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-repair-string.xml b/reference/tidy/functions/tidy-repair-string.xml new file mode 100644 index 0000000000..7dbde11166 --- /dev/null +++ b/reference/tidy/functions/tidy-repair-string.xml @@ -0,0 +1,43 @@ + + + + + + tidy_repair_string + + Repair a string using an optionally provided configuration file + + + + Description + + booleantidy_repair_string + stringdata + stringconfig_file + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-reset-config.xml b/reference/tidy/functions/tidy-reset-config.xml new file mode 100644 index 0000000000..20af03aef5 --- /dev/null +++ b/reference/tidy/functions/tidy-reset-config.xml @@ -0,0 +1,42 @@ + + + + + + tidy_reset_config + + Restore Tidy configuration to default values + + + + Description + + stringtidy_reset_config + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-save-config.xml b/reference/tidy/functions/tidy-save-config.xml new file mode 100644 index 0000000000..c9356adfa6 --- /dev/null +++ b/reference/tidy/functions/tidy-save-config.xml @@ -0,0 +1,42 @@ + + + + + + tidy_save_config + + Save current settings to named file. Only non-default values are written. + + + + Description + + booleantidy_save_config + stringfilename + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-set-encoding.xml b/reference/tidy/functions/tidy-set-encoding.xml new file mode 100644 index 0000000000..4074716db7 --- /dev/null +++ b/reference/tidy/functions/tidy-set-encoding.xml @@ -0,0 +1,44 @@ + + + + + + tidy_set_encoding + + Set the input/output character encoding for parsing markup. + Values include: ascii, latin1, raw, utf8, iso2022, mac, win1252, utf16le, + utf16be, utf16, big5 and shiftjis. + + + + Description + + booleantidy_set_encoding + stringencoding + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-setopt.xml b/reference/tidy/functions/tidy-setopt.xml new file mode 100644 index 0000000000..735a2eff25 --- /dev/null +++ b/reference/tidy/functions/tidy-setopt.xml @@ -0,0 +1,43 @@ + + + + + + tidy_setopt + + Updates the configuration settings for the specified tidy document. + + + + Description + + booleantidy_setopt + stringoption + mixednewvalue + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/functions/tidy-warning-count.xml b/reference/tidy/functions/tidy-warning-count.xml new file mode 100644 index 0000000000..2a5eec88ca --- /dev/null +++ b/reference/tidy/functions/tidy-warning-count.xml @@ -0,0 +1,42 @@ + + + + + + tidy_warning_count + + Returns the Number of Tidy warnings encountered for specified document. + + + + Description + + inttidy_warning_count + + + + &warn.undocumented.func; + + + + + diff --git a/reference/tidy/reference.xml b/reference/tidy/reference.xml new file mode 100644 index 0000000000..64585462b2 --- /dev/null +++ b/reference/tidy/reference.xml @@ -0,0 +1,47 @@ + + + + + tidy Functions + tidy + + +
+ &reftitle.intro; + + This is the tidy extension. It + currently only lists the proto definitions. + +
+
+ &reftitle.install; + + Tidy is currently available for PHP 4.3.x and PHP 5 as a PECL + extension. To use Tidy, you will need libtidy installed (available + on the tidy homepage http://tidy.sf.net/) and the tidy extension + from PECL http://pecl.php.net/ + +
+
+ &reference.tidy.functions; +
+