Возвращает документацию по названию опции

# tidy::getOptDoc

# tidy_get_opt_doc

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

tidy::getOptDoc -- tidy_get_opt_doc — Возвращает документацию по названию опции

### Описание

Объектно-ориентированный стиль

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

Процедурный стиль

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

Функция tidy_get_opt_doc() возвращает документацию по названию опции.

> Замечание:

> Функция работает только с библиотекой libtidy не старше 25 апреля 2005 г.

### Список параметров

`tidy`

  Объект Tidy.

`optname`

  Название опции.

### Возвращаемые значения

Функция возвращает строку, если опция существует и для неё написали документацию, иначе возвращает `false`.

### Примеры

Пример #1 Пример вывода каждой опции с документацией и значением по умолчанию

    <?php

    $tidy = new tidy;
    $config = $tidy->getConfig();

    ksort($config);

    foreach ($config as $opt => $val) {
        if (!$doc = $tidy->getOptDoc($opt)) {
            $doc = 'Документация не существует!';
         }

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

    ?>

### Смотрите также

- tidy::getConfig() - Получает текущую конфигурацию Tidy
- tidy::getOpt() - Возвращает значение указанного параметра конфигурации для документа tidy

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