Module epydoc.objdoc
Support for ObjDocs, which encode the information about a 
Python object that is necessary to create its documentation. 
ObjDocs are created and managed by the DocMap 
class, which acts like a dictionary from UIDs to 
ObjDocs.
Textual documentation entries (e.g., module descriptions, method 
descriptions, variable types, see-also entries) are encoded as ParsedDocstrings.
Each Python object is identified by a globally unique identifier, 
implemented with the UID class. These identifiers are also used 
by the Link class to implement crossreferencing between 
ObjDocs.
  | Classes | 
| ClassDoc | The documentation for a class. | 
| DocField | A generic docstring field. | 
| DocMap | A dictionary mapping each object to the object's documentation. | 
| FuncDoc | The documentation for a function. | 
| ModuleDoc | The documentation for a module or package. | 
| ObjDoc | A base class for encoding the information about a Python object that 
is necessary to create its documentation. | 
| Param | The documentation for a function parameter. | 
| PropertyDoc | The documentation for a property. | 
| Raise | The documentation for the raising of an exception. | 
| Var | The documentation for a variable. | 
  | Function Summary | 
|  | report_param_mismatches(docmap) | 
| None | set_default_docformat(new_format)Change the default value for
 __docformat__to the given 
value. | 
  | Variable Summary | 
| str | DEFAULT_DOCFORMAT: The default value for__docformat__, if it is not 
specified by modules. | 
| tuple | KNOWN_DOCFORMATS=('plaintext', 'epytext', 'restructure... | 
| set_default_docformat(new_format)
  Change the default value for__docformat__to the given 
  value. The current default value for__docformat__is 
  recorded inDEFAULT_DOCFORMAT.
    Parameters:new_format-
         The new default value for__docformat__(type=
 string)
 Returns:
        None
 See Also: DEFAULT_DOCFORMAT
 | 
| DEFAULT_DOCFORMATThe default value for__docformat__, if it is not 
specified by modules.__docformat__is a module variable 
that specifies the markup language for the docstrings in a module. Its 
value is a string, consisting the name of a markup language, optionally 
followed by a language code (such asenfor English). Some 
typical values for__docformat__are:
>>> __docformat__ = 'plaintext'
>>> __docformat__ = 'epytext'
>>> __docformat__ = 'epytext en' 
  
  
    
      Type:
          strValue: | 
| KNOWN_DOCFORMATS
  
  
    
      Type:
          tupleValue:| 
('plaintext', 'epytext', 'restructuredtext', 'javadoc')                 | 
 |