与えられたオプション名に対するドキュメントを返す

# 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() は、 与えられたオプション名に対するドキュメントを返します。

> 注意:

> この関数を有効にするには、少なくとも2005年4月25日以降の libtidy が必要です。

### パラメータ

`tidy`

  Tidy オブジェクト。

`option`

  オプション名。

### 戻り値

オプションが存在し、かつドキュメントが利用可能であれば、文字列を返します。 その他の場合は `false` を返します。

### 例

例1 すべてのオプションについてのドキュメントとデフォルト値をプリントする

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

    ?>

### 参考

- tidy::getConfig() - 現在の Tidy の設定を取得する
- tidy::getOpt() - Tidy ドキュメントについて指定した設定オプションの値を返す

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