Documentation set written in dia format.
Parameters
Adds no additional parameters not understood by DocSet.
Do not use multiple lines in the class docstring, since it shows up as
part of the generated help message for the app and multiple lines throws
off the formatting.
|
Methods
|
|
_GetAllClassesInformation
__init__
_writeAllClasses
_writeClass
_writeModuleConnections
_writeModules
_writePackages
write
|
|
|
_GetAllClassesInformation
|
_GetAllClassesInformation ( self )
Returns a tuple (classes,class2bases, class2module), where
classes is a list of all classes to write,
class2bases is a dictionary containing for each class
the list of all direct subclasses and
class2module is a dictionary containing for each class the
module to which this class belongs
|
|
|
__init__
|
__init__ (
self,
formatterFactory,
parserFunc,
inputModuleNames,
usePackages=0,
defaultParserConfigValues={},
**extraNamedParameters,
)
|
|
|
_writeAllClasses
|
_writeAllClasses (
self,
classes,
class2bases,
class2module,
)
|
|
|
_writeClass
|
_writeClass (
self,
parent,
class_name,
)
Output the documentation for the class in the parent object.
|
|
|
_writeModuleConnections
|
_writeModuleConnections ( self, module_name )
Output the documentation for the module named.
|
|
|
_writeModules
|
_writeModules ( self )
Output documentation for all modules.
|
|
|
_writePackages
|
_writePackages ( self )
Output documentation for all packages.
|
|
|
write
|
write ( self )
Write the documentation set to the output.
|
|