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 Python objects to
ObjDocs.
Textual documentation entries (e.g., module descriptions, method
descriptions, variable types, see-also entries) are encoded as DOM
Elements, using the DTD described in the epytext
module.
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. |
DocMap |
A dictionary mapping each object to the object's documentation. |
FuncDoc |
The documentation for a function of method. |
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. |
Raise |
The documentation for the raising of an exception. |
Var |
The documentation for an individual variable. |