Returns the documentation for the given option name

# tidy::getOptDoc

# tidy_get_opt_doc

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

tidy::getOptDoc -- tidy_get_opt_doc — Returns the documentation for the given option name

### Beschreibung

Objektorientierter Stil

public function tidy::getOptDoc(string `$option`): string|false

Prozeduraler Stil

function tidy_get_opt_doc(tidy `$tidy`, string `$option`): string|false

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

> Hinweis:

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

### Parameter-Liste

`tidy`

  Das Tidy Objekt.

`option`

  The option name

### Rückgabewerte

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

### Beispiele

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

    ?>

### Siehe auch

- tidy::getConfig() - Get current Tidy configuration
- tidy::getOpt() - Returns the value of the specified configuration option for the tidy document

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open