tidy_get_opt_doc

Description

Procedural style:

Object oriented style:

tidy_get_opt_doc() returns the documentation for the given option name.

Parameters

Return Values

Returns a string if the option exists and has documentation available, or FALSE otherwise.

Examples

Example 1. Print all options along with their documentation and default value <?php $tidy = new tidy; $config = $tidy->getConfig(); ksort($config); foreach ($config as $opt => $val) {     if (!$doc = $tidy->getOptDoc($opt))         $doc = 'no documentation available!';     $val = ($tidy->getOpt($opt) === true)  ? 'true'  : $val;     $val = ($tidy->getOpt($opt) === false) ? 'false' : $val;     echo "<p><b>$opt</b> (default: '$val')<br />".          "$doc</p><hr />\n"; } ?>

See Also