tidy::getOptDoc

tidy_get_opt_doc

Returns the documentation for the given option name

&reftitle.description;

&style.oop;

public ``string``false```tidy::getOptDoc` `string` `option`

&style.procedural;

``string``false```tidy_get_opt_doc` `tidy` `tidy` `string` `option`

`tidy_get_opt_doc` returns the documentation for the given option name.

You need at least libtidy from 25 April, 2005 for this function be available.

&reftitle.parameters;

`tidy`

- &tidy.object;

`option`

- The option name

&reftitle.returnvalues;

Returns a string if the option exists and has documentation available, or &false; otherwise.

&reftitle.examples;

### 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";
    }

    ?>

&reftitle.seealso;

- `tidy::getconfig`
- `tidy::getopt`