# tidy::getOptDoc

# tidy_get_opt_doc

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

tidy::getOptDoc -- tidy_get_opt_doc — Devuelve la documentación correspondiente a un nombre de opción dado

### Descripción

Estilo orientado a objetos

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

Estilo por procedimientos

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

Devuelve la documentación tidy_get_opt_doc() para el nombre de opción dado.

> Nota:

> Se requiere al menos la librería libtidy del 25 April del 2005 paa que la función esté disponible.

### Parámetros

`tidy`

  El objeto Tidy.

`option`

  El nombre de la opción

### Valores devueltos

Devuelve una cadena si la opción existe y tiene documentación disponible, o `false` de otro modo.

### Ejemplos

Ejemplo #1 Imprimir todas las opciones, junto con su documentación y sus valores por omisión

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

### Ver también

- tidy::getconfig() - Obtiene la configuración actual de Tidy
- tidy::getopt() - Devuelve el valor de la opción de configuración especificada para el documento tidy