epydoc.objdoc.ModuleDoc

Package epydoc :: Module objdoc :: Class ModuleDoc

[show private | hide private]

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:

classes: A list of all classes contained in the module/package.
functions: A list of all functions contained in the module/package.
variables: A list of all variables contained in the module/package.
modules: A list of all modules contained in the package (packages only).
imported objects: Lists of imported objects, sorted by type.

Method Summary
	`__init__(self, uid, verbosity)`
	`__repr__(self)`

Accessors
`list` of `Link`	`functions(self)` Return a list of all functions defined by the module/package documented by this `ModuleDoc`.
`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 `Var`	`variables(self)` Return a list of all variables defined by the module/package documented by this `ModuleDoc`, 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_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.
`UID` or `None`	`package(self)` Return the package that contains the module documented by this `ModuleDoc`, or `None` if no package contains the module.
`boolean`	`ispackage(self)` Return true if this `ModuleDoc` documents a package (not a module).
`boolean`	`ismodule(self)` Return true if this `ModuleDoc` documents a module (not a package).
`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.
`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.
`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.
Inherited from `ObjDoc`: `by_group`, `defines_groups`, `descr`, `field_values`, `fields`, `groups`, `has_docstring`, `sortorder`, `summary`, `uid`
Modifiers
	`remove_autogenerated_variables(self)`
`None`	`add_modules(self, modules)` Register submodules for the package doumented by this `ModuleDoc`.

Class Variable Summary
Docstring Parsing
Inherited from `ObjDoc`: `STANDARD_FIELDS`

Method Details

functions(self)

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

classes(self)

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

variables(self)

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

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_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)

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)

ispackage(self)

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

ismodule(self)

Returns:: True if this ModuleDoc documents a module (not a package).
(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.

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)

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)

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

Generated by Epydoc 2.1 on Sat Mar 20 17:46:10 2004

http://epydoc.sf.net