4Suite API Documentation: Ft.Lib.DistExt.Formatters.ApiFormatter

4Suite™ API Documentation

# ► Module Ft.Lib.DistExt.Formatters.ApiFormatter

Classes: ApiFormatter

## Classes

class ApiFormatter(Ft.Lib.DistExt.Formatters.XmlFormatter.XmlFormatter)

  ### Methods

  __init__(self, command, modules)
    Overrides: __init__ from class XmlFormatter
  doc_arguments(self, object)
  doc_class(self, klass, name)
    Produce XML documentation for a given class object.
  doc_function(self, func, name)
    Document a function
  doc_global(self, object, name)
    Produce XML documentation for a data object.
  doc_inherited(self, object, name, klass, kind)
    Produce XML documentation for an inherited object.
  doc_member(self, object, name, klass, kind)
    Produce XML documentation for a data object.
  doc_method(self, method, name, klass, kind)
    Document a method, class method or static method as given by 'kind'
  doc_methoddescriptor(self, descr, name, klass, kind)
    Document a class method or static method as given by 'kind'
  doc_submodule(self, module, name)
    Produce XML documentation for a submodule
  document(self, module)
    Produce documentation for a given module object.
    Overrides: document from class XmlFormatter
  format_arg(self, arg, default=None)
  isdocumented(self, name)
  ispublic(self, name)
    # 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 "private" names should not be used # outside the given module.
  write_description(self, object)
    Produce XML tag(s) for an object description.

  ### Methods inherited from class Ft.Lib.DistExt.Formatters.XmlFormatter.XmlFormatter

  end_element, format, section, start_element, warn, write_element

  ### Methods inherited from class Ft.Lib.DistExt.Formatters.XmlFormatter.XmlRepr

  escape, repr, repr_str, repr_unicode

  ### Methods inherited from class pydoc.TextRepr

  repr1, repr_instance, repr_string

  ### Methods inherited from class repr.Repr

  repr_array, repr_deque, repr_dict, repr_frozenset, repr_list, repr_long, repr_set, repr_tuple

  ### Members

  document_type = <type 'module'>
    module(name[, doc])

        Create a module object.
        The name must be a string; the optional doc argument can have any type.

  ### Members inherited from class Ft.Lib.DistExt.Formatters.XmlFormatter.XmlFormatter

  indent