From ee2ede48106fb3eba35b6f4e00c34fda891a7511 Mon Sep 17 00:00:00 2001 From: Nuno Lopes Date: Sun, 18 Jan 2004 12:45:56 +0000 Subject: [PATCH] added documentation and examples git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@149108 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/tidy/functions/tidy-get-body.xml | 48 +++++++++++++++++-- reference/tidy/functions/tidy-get-head.xml | 50 ++++++++++++++++++-- reference/tidy/functions/tidy-get-html.xml | 55 ++++++++++++++++++++-- 3 files changed, 139 insertions(+), 14 deletions(-) diff --git a/reference/tidy/functions/tidy-get-body.xml b/reference/tidy/functions/tidy-get-body.xml index 3c26bea834..90353c9c7f 100644 --- a/reference/tidy/functions/tidy-get-body.xml +++ b/reference/tidy/functions/tidy-get-body.xml @@ -1,11 +1,10 @@ - - + tidy_get_body - Returns a TidyNode Object starting from the >BODY< tag of the tidy parse tree + Returns a TidyNode Object starting from the <body> tag of the tidy parse tree @@ -14,9 +13,50 @@ objecttidy_get_body resourcetidy + + This function returns a TidyNode object starting from the <body> + tag of the tidy parse tree. + + + + <function>tidy_get_body</function> example + + + + test + + +

paragraph

+ +'; - &warn.undocumented.func; +$tidy = tidy_parse_string($html); + +$body = tidy_get_body($tidy); +echo $body->value; +?> +]]> + + + The above example will output: + + + +

paragraph

+ +]]> + + + ¬e.tidy.ze2; + + See also tidy_get_head and + tidy_get_html. + diff --git a/reference/tidy/functions/tidy-get-head.xml b/reference/tidy/functions/tidy-get-head.xml index 97f29c5955..5fe46e3510 100644 --- a/reference/tidy/functions/tidy-get-head.xml +++ b/reference/tidy/functions/tidy-get-head.xml @@ -1,22 +1,62 @@ - - + tidy_get_head - Returns a TidyNode Object starting from the >HEAD< tag of the tidy parse tree + Returns a TidyNode Object starting from the <head> tag of the tidy parse tree Description objecttidy_get_head - + resourcetidy + + This function returns a TidyNode object starting from the <head> + tag of the tidy parse tree. + + + + <function>tidy_get_head</function> example + + + + test + + +

paragraph

+ +'; - &warn.undocumented.func; +$tidy = tidy_parse_string($html); + +$head = tidy_get_head($tidy); +echo $head->value; +?> +]]> + + + The above example will output: + + + +test + +]]> + + + ¬e.tidy.ze2; + + See also tidy_get_body and + tidy_get_html. + diff --git a/reference/tidy/functions/tidy-get-html.xml b/reference/tidy/functions/tidy-get-html.xml index a5265d6695..5c98ae6347 100644 --- a/reference/tidy/functions/tidy-get-html.xml +++ b/reference/tidy/functions/tidy-get-html.xml @@ -1,22 +1,67 @@ - - + tidy_get_html - Returns a TidyNode Object starting from the >HTML< tag of the tidy parse tree + Returns a TidyNode Object starting from the <html> tag of the tidy parse tree Description objecttidy_get_html - + resourcetidy + + This function returns a TidyNode object starting from the <html> + tag of the tidy parse tree. + + + + <function>tidy_get_html</function> example + + + + test + + +

paragraph

+ +'; - &warn.undocumented.func; +$tidy = tidy_parse_string($html); + +$html = tidy_get_html($tidy); +echo $html->value; +?> +]]> + + + The above example will output: + + + + +test + + +

paragraph

+ + +]]> + + + ¬e.tidy.ze2; + + See also tidy_get_body and + tidy_get_head. +