Package epydoc :: Module objdoc :: Class ModuleDoc
[show private | hide private]
[frames | no frames]

Class ModuleDoc

ObjDoc --+
         |
        ModuleDoc


The documentation for a module or package. This documentation consists of standard pieces of documentation (as defined in ObjDoc), and the following module-specific pieces of documentation:
Method Summary
  __init__(self, uid, verbosity)
  __repr__(self)
    Accessors
list of Link classes(self)
Return a list of all classes defined by the module/package documented by this ModuleDoc, sorted by name.
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, sorted by name.
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, sorted by name.
list of Link imported_modules(self)
Return a list of all modules that are imported by the module/package documented by this ModuleDoc, sorted by name.
list of Var imported_variables(self)
Return a list of all variables contained in the module/package documented by this ModuleDoc that are not defined by that module/package, sorted by name.
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, sorted by name.
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 Var variables(self)
Return a list of all variables defined by the module/package documented by this ModuleDoc, sorted by name.
Inherited from ObjDoc: by_group, defines_groups, descr, field_values, fields, groups, has_docstring, sortorder, summary, uid
    Modifiers
None add_modules(self, modules)
Register submodules for the package doumented by this ModuleDoc.
  remove_autogenerated_variables(self)

Class Variable Summary
    Docstring Parsing
Inherited from ObjDoc: STANDARD_FIELDS

Method Details

add_modules(self, modules)

Register submodules 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:
modules - A list of modules or subpackages.
           (type=list of UID)
Returns:
None

classes(self)

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

functions(self)

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

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, sorted by name.
           (type=list of Link)

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, sorted by name.
           (type=list of Link)

imported_modules(self)

Returns:
A list of all modules that are imported by the module/package documented by this ModuleDoc, sorted by name.
           (type=list of Link)

imported_variables(self)

Returns:
A list of all variables contained in the module/package documented by this ModuleDoc that are not defined by that module/package, sorted by name.
           (type=list of Var)

ismodule(self)

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

ispackage(self)

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

modules(self)

Returns:
A list of the known modules and subpackages conained in the package documented by this ModuleDoc, sorted by name.
           (type=list of Link)
Raises:
TypeError - If this ModuleDoc does not document a 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(self)

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

Generated by Epydoc 2.0 on Tue Jul 22 04:20:48 2003 http://epydoc.sf.net