From fa216f30ce208bd85f1a6f2c42ab06ff8d96f80a Mon Sep 17 00:00:00 2001 From: Nuno Lopes Date: Sun, 15 Feb 2004 17:21:04 +0000 Subject: [PATCH] some more tidy documentation git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@151447 c90b9560-bf6c-de11-be94-00142212c4b1 --- language-snippets.ent | 2 +- reference/tidy/functions/tidy-diagnose.xml | 12 ++-- .../tidy/functions/tidy-parse-string.xml | 66 ++++++++++++++++++- reference/tidy/functions/tidy-repair-file.xml | 33 ++++++++-- .../tidy/functions/tidy-repair-string.xml | 6 +- 5 files changed, 101 insertions(+), 18 deletions(-) diff --git a/language-snippets.ent b/language-snippets.ent index 8fdf21032d..89fe7f75a4 100644 --- a/language-snippets.ent +++ b/language-snippets.ent @@ -263,5 +263,5 @@ are case-sensitive'> Tidy 1.0. It became obsolete in Tidy 2.0 and thus has been removed.'> The optional parameters -config_options and encoding were +config and encoding were added in Tidy 2.0.'> diff --git a/reference/tidy/functions/tidy-diagnose.xml b/reference/tidy/functions/tidy-diagnose.xml index 20392d1ade..4d87926539 100644 --- a/reference/tidy/functions/tidy-diagnose.xml +++ b/reference/tidy/functions/tidy-diagnose.xml @@ -1,6 +1,5 @@ - - + tidy_diagnose @@ -12,11 +11,12 @@ Description booltidy_diagnose - + resourcetidy - - &warn.undocumented.func; - + + tidy_diagnose runs diagnostic tests on the given + resource. + diff --git a/reference/tidy/functions/tidy-parse-string.xml b/reference/tidy/functions/tidy-parse-string.xml index 8ed08dc2a1..e504f54c58 100644 --- a/reference/tidy/functions/tidy-parse-string.xml +++ b/reference/tidy/functions/tidy-parse-string.xml @@ -1,6 +1,5 @@ - - + tidy_parse_string @@ -14,9 +13,70 @@ booltidy_parse_string stringinput + + tidy_parse_string parses a document stored in a + string. + + + + <function>tidy_parse_string</function> example + + - &warn.undocumented.func; + + + test + + +

error
another line + + + TRUE, + 'output-xhtml' => TRUE, + 'wrap', 200); + +$tidy = tidy_repair_string($buffer, $config, 'UTF8'); + +echo $tidy; +?> +]]> + + + The above example will output: + + + + + + + test + + + +

+ error
+ another line +

+ + +]]> + + + + + See also tidy_parse_file, + tidy_repair_file and + tidy_repair_string. + diff --git a/reference/tidy/functions/tidy-repair-file.xml b/reference/tidy/functions/tidy-repair-file.xml index 4042ef878e..5070808421 100644 --- a/reference/tidy/functions/tidy-repair-file.xml +++ b/reference/tidy/functions/tidy-repair-file.xml @@ -1,11 +1,10 @@ - - + tidy_repair_file - Repair a file using an optionally provided configuration file + Repair a file and return it as a string @@ -13,12 +12,36 @@ booltidy_repair_file stringfilename - stringconfig_file + mixedconfig + stringencoding booluse_include_path + + This function repairs the given file and returns it as a string. + + + + <function>tidy_repair_file</function> example + + +]]> + + + + ¬e.tidy.2only; + + See also tidy_parse_file, + tidy_parse_string and + tidy_repair_string. + diff --git a/reference/tidy/functions/tidy-repair-string.xml b/reference/tidy/functions/tidy-repair-string.xml index 5a62b556dd..584f4ef184 100644 --- a/reference/tidy/functions/tidy-repair-string.xml +++ b/reference/tidy/functions/tidy-repair-string.xml @@ -1,5 +1,5 @@ - + tidy_repair_string @@ -12,7 +12,7 @@ booltidy_repair_string stringdata - stringconfig_file + mixedconfig stringencoding @@ -63,12 +63,12 @@ echo $tidy; + ¬e.tidy.2only; See also tidy_parse_file, tidy_parse_string and tidy_repair_file. - ¬e.tidy.2only;