<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="tidy.getoptdoc" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>tidy::getOptDoc</refname>
  <refname>tidy_get_opt_doc</refname>
  <refpurpose>
   Returns the documentation for the given option name
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop;</para>
  <methodsynopsis role="tidy">
   <modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>tidy::getOptDoc</methodname>
   <methodparam><type>string</type><parameter>option</parameter></methodparam>
  </methodsynopsis>
  <para>&style.procedural;</para>
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>tidy_get_opt_doc</methodname>
   <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
   <methodparam><type>string</type><parameter>option</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>tidy_get_opt_doc</function> returns the documentation for the
   given option name.
  </para>
  <note>
   <para>
    You need at least libtidy from 25 April, 2005 for this function be
    available.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>tidy</parameter></term>
     <listitem>
      <para>
       &tidy.object;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       The option name
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a string if the option exists and has documentation available, or
   &false; otherwise.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Print all options along with their documentation and default value</title>
    <programlisting role="php">
<![CDATA[
<?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";
}

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>tidy::getconfig</function></member>
    <member><function>tidy::getopt</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
