Package       Module       Class       Trees       Index       Help   
epydoc
[show private | hide private]

epydoc.objdoc
Class epydoc.objdoc.ModuleDoc

ObjDoc --+
         |
        ModuleDoc

The documentation for a module or package. This documentation consists of standard documentation fields (descr, author, etc.) and the following module-specific fields: For more information on the standard documentation fields, see ObjDoc.
Method Summary
  __init__(self, obj, verbosity)
Create the documentation for the given object.
  __repr__(self)
None add_module(self, module)
Register a submodule for the package doumented by this ModuleDoc.
list of Element authors(self)
Return a list of the authors of the object documented by this ObjDoc. (inherited from ObjDoc)
list of Link classes(self)
Return a list of all classes defined by the module/package documented by this ModuleDoc.
Element descr(self)
Return a description of the object documented by this ObjDoc. (inherited from ObjDoc)
boolean documented(self)
Return true if the object documented by this ObjDoc has a docstring. (inherited from ObjDoc)
list of Link functions(self)
Return a list of all functions defined by the module/package documented by this ModuleDoc.
list of Link imported_classes(self)
Return a list of all classes contained in the module/package documented by this ModuleDoc that are not defined by that module/package.
list of Link imported_functions(self)
Return a list of all functions contained in the module/package documented by this ModuleDoc that are not defined by that module/package.
boolean ismodule(self)
Return true if this ModuleDoc documents a module (not a package).
boolean ispackage(self)
Return true if this ModuleDoc documents a package (not a module).
list of Link modules(self)
Return a list of the known modules and subpackages conained in the package documented by this ModuleDoc.
UID or None package(self)
Return the package that contains the module documented by this ModuleDoc, or None if no package contains the module.
list of Element seealsos(self)
Return a list of objects related to the object documented by this ObjDoc. (inherited from ObjDoc)
list of string sortorder(self)
Return the object's __epydoc_sort__ list. (inherited from ObjDoc)
UID uid(self)
Return the UID of the object documented by this ObjDoc. (inherited from ObjDoc)
list of Var variables(self)
Return a list of all variables defined by the module/package documented by this ModuleDoc.
Element version(self)
Return the version of the object documented by this ObjDoc. (inherited from ObjDoc)

Method Details

Constructor

__init__(self, mod, verbosity=0)

Overrides:
epydoc.objdoc.ObjDoc.__init__

Representation operator

__repr__(self)

add_module

add_module(self, module)

Register a submodule for the package doumented by this ModuleDoc. This must be done externally, since we can't determine the submodules of a package through introspection alone. This is automatically called by DocMap.add when new modules are added to a DocMap.
Parameters:
module - The unique identifier of the module or subpackage.
           (type=UID)
Returns:
None

classes

classes(self)

Returns:
A list of all classes defined by the module/package documented by this ModuleDoc.
           (type=list of Link)

functions

functions(self)

Returns:
A list of all functions defined by the module/package documented by this ModuleDoc.
           (type=list of Link)

imported_classes

imported_classes(self)

Returns:
A list of all classes contained in the module/package documented by this ModuleDoc that are not defined by that module/package.
           (type=list of Link)

imported_functions

imported_functions(self)

Returns:
A list of all functions contained in the module/package documented by this ModuleDoc that are not defined by that module/package.
           (type=list of Link)

ismodule

ismodule(self)

Returns:
True if this ModuleDoc documents a module (not a package).
           (type=boolean)

ispackage

ispackage(self)

Returns:
True if this ModuleDoc documents a package (not a module).
           (type=boolean)

modules

modules(self)

Returns:
A list of the known modules and subpackages conained in the package documented by this ModuleDoc.
           (type=list of Link)
Raises:
TypeError - If this ModuleDoc does not document a package.

package

package(self)

Returns:
The package that contains the module documented by this ModuleDoc, or None if no package contains the module.
           (type=UID or None)

variables

variables(self)

Returns:
A list of all variables defined by the module/package documented by this ModuleDoc.
           (type=list of Var)

   Package       Module       Class       Trees       Index       Help   
epydoc
Generated by Epydoc on Sun Oct 6 03:32:14 2002 http://epydoc.sf.net