<?xml version="1.0" encoding="iso-8859-1"?>
<module name="Ft.Lib.DistExt.Formatters.ApiFormatter" file="/work/a/ports/textproc/py-4suite-xml/work/4Suite-1.0b3/build/lib.freebsd-6.1-PRERELEASE-i386-2.4/Ft/Lib/DistExt/Formatters/ApiFormatter.py">
  <modification-date>2005-09-20 03:09:52</modification-date>
  <abstract/>
  <description/>
  <classes>
    <class name="ApiFormatter" public="yes">
      <bases>
        <base documented="yes" class="XmlFormatter" module="Ft.Lib.DistExt.Formatters.XmlFormatter"/>
      </bases>
      <abstract/>
      <description/>
      <method-resolution-order>
        <base name="ApiFormatter" module="Ft.Lib.DistExt.Formatters.ApiFormatter"/>
        <base name="XmlFormatter" module="Ft.Lib.DistExt.Formatters.XmlFormatter"/>
        <base name="XmlRepr" module="Ft.Lib.DistExt.Formatters.XmlFormatter"/>
        <base name="TextRepr" module="pydoc"/>
        <base name="Repr" module="repr"/>
      </method-resolution-order>
      <methods name="Repr" module="repr">
        <method public="no" name="__init__" id="ApiFormatter-__init__">
          <abstract/>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="command"/>
            <arg name="modules"/>
          </arguments>
          <overrides documented="yes" class="XmlFormatter" module="Ft.Lib.DistExt.Formatters.XmlFormatter"/>
        </method>
        <method public="yes" name="doc_arguments" id="ApiFormatter-doc_arguments">
          <abstract/>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="object"/>
          </arguments>
        </method>
        <method public="yes" name="doc_class" id="ApiFormatter-doc_class">
          <abstract>Produce XML documentation for a given class object.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="klass"/>
            <arg name="name"/>
          </arguments>
        </method>
        <method public="yes" name="doc_function" id="ApiFormatter-doc_function">
          <abstract>Document a function</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="func"/>
            <arg name="name"/>
          </arguments>
        </method>
        <method public="yes" name="doc_global" id="ApiFormatter-doc_global">
          <abstract>Produce XML documentation for a data object.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="object"/>
            <arg name="name"/>
          </arguments>
        </method>
        <method public="yes" name="doc_inherited" id="ApiFormatter-doc_inherited">
          <abstract>Produce XML documentation for an inherited object.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="object"/>
            <arg name="name"/>
            <arg name="klass"/>
            <arg name="kind"/>
          </arguments>
        </method>
        <method public="yes" name="doc_member" id="ApiFormatter-doc_member">
          <abstract>Produce XML documentation for a data object.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="object"/>
            <arg name="name"/>
            <arg name="klass"/>
            <arg name="kind"/>
          </arguments>
        </method>
        <method public="yes" name="doc_method" id="ApiFormatter-doc_method">
          <abstract>Document a method, class method or static method as given by 'kind'</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="method"/>
            <arg name="name"/>
            <arg name="klass"/>
            <arg name="kind"/>
          </arguments>
        </method>
        <method public="yes" name="doc_methoddescriptor" id="ApiFormatter-doc_methoddescriptor">
          <abstract>Document a class method or static method as given by 'kind'</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="descr"/>
            <arg name="name"/>
            <arg name="klass"/>
            <arg name="kind"/>
          </arguments>
        </method>
        <method public="yes" name="doc_module" id="ApiFormatter-doc_module">
          <abstract>Produce documentation for a given module object.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="module"/>
          </arguments>
          <overrides documented="yes" class="XmlFormatter" module="Ft.Lib.DistExt.Formatters.XmlFormatter"/>
        </method>
        <method public="yes" name="doc_submodule" id="ApiFormatter-doc_submodule">
          <abstract>Produce XML documentation for a submodule</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="module"/>
            <arg name="name"/>
          </arguments>
        </method>
        <method public="yes" name="format_arg" id="ApiFormatter-format_arg">
          <abstract/>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="arg"/>
            <arg default="None" name="default"/>
          </arguments>
        </method>
        <method public="yes" name="isdocumented" id="ApiFormatter-isdocumented">
          <abstract/>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="name"/>
          </arguments>
        </method>
        <method public="yes" name="ispublic" id="ApiFormatter-ispublic">
          <abstract># Some names are not invisible, but are still not public.  Such names
# which are not public are still documented, but this documentation is
# not displayed, because these &quot;private&quot; names should not be used
# outside the given module.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="name"/>
          </arguments>
        </method>
        <method public="yes" name="write_description" id="ApiFormatter-write_description">
          <abstract>Produce XML tag(s) for an object description.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="object"/>
          </arguments>
        </method>
      </methods>
      <inherited-methods documented="yes" class="XmlFormatter" module="Ft.Lib.DistExt.Formatters.XmlFormatter">
        <member-reference name="document" public="yes"/>
        <member-reference name="end_element" public="yes"/>
        <member-reference name="section" public="yes"/>
        <member-reference name="start_element" public="yes"/>
        <member-reference name="warn" public="yes"/>
        <member-reference name="write_element" public="yes"/>
      </inherited-methods>
      <inherited-members documented="yes" class="XmlFormatter" module="Ft.Lib.DistExt.Formatters.XmlFormatter">
        <member-reference name="indent" public="yes"/>
      </inherited-members>
      <inherited-methods documented="yes" class="XmlRepr" module="Ft.Lib.DistExt.Formatters.XmlFormatter">
        <member-reference name="escape" public="yes"/>
        <member-reference name="repr" public="yes"/>
        <member-reference name="repr_str" public="yes"/>
        <member-reference name="repr_unicode" public="yes"/>
      </inherited-methods>
      <inherited-methods documented="no" class="TextRepr" module="pydoc">
        <member-reference name="repr1" public="yes"/>
        <member-reference name="repr_instance" public="yes"/>
        <member-reference name="repr_string" public="yes"/>
      </inherited-methods>
      <inherited-methods documented="no" class="Repr" module="repr">
        <member-reference name="repr_array" public="yes"/>
        <member-reference name="repr_deque" public="yes"/>
        <member-reference name="repr_dict" public="yes"/>
        <member-reference name="repr_frozenset" public="yes"/>
        <member-reference name="repr_list" public="yes"/>
        <member-reference name="repr_long" public="yes"/>
        <member-reference name="repr_set" public="yes"/>
        <member-reference name="repr_tuple" public="yes"/>
      </inherited-methods>
    </class>
  </classes>
  <functions>
    <function public="no" name="_visiblename" id="_visiblename">
      <abstract>Decide whether to show documentation on a variable.</abstract>
      <description/>
      <arguments>
        <arg name="name"/>
      </arguments>
    </function>
  </functions>
</module>
