Module implementing the builtin documentation generator.
The different parts of the module document are assembled from the parsed Python file. The appearance is determined by several templates defined within this module.
ModuleDocument | Class implementing the builtin documentation generator. |
TagError | Exception class raised, if an invalid documentation tag was found. |
None |
Class implementing the builtin documentation generator.
ModuleDocument | Constructor |
checkDeprecated | Private method to check, if the object to be documented contains a deprecated flag. |
description | Method used to get the description of the module. |
formatDescription | Private method to format the contents of the documentation string. |
genClassListSection | Private method to generate the section listing all classes of the module. |
genClassesSection | Private method to generate the document section with details about classes. |
genDescriptionListSection | Private method to generate the list section of a description. |
genDocument | Method to generate the source code documentation. |
genFunctionListSection | Private method to generate the section listing all functions of the module. |
genFunctionsSection | Private method to generate the document section with details about functions. |
genListSection | Private method to generate a list section of the document. |
genMethodSection | Private method to generate the method details section. |
genMethodsListSection | Private method to generate the methods list section of a class. |
genModuleSection | Private method to generate the body of the document. |
genParagraphs | Private method to assemble the descriptive paragraphs of a docstring. |
genParamDescriptionListSection | Private method to generate the list section of a description. |
genRbModulesClassesListSection | Private method to generate the classes list section of a Ruby module. |
genRbModulesClassesSection | Private method to generate the Ruby module classes details section. |
genRbModulesListSection | Private method to generate the section listing all modules of the file (Ruby only). |
genRbModulesSection | Private method to generate the document section with details about Ruby modules. |
getShortDescription | Private method to determine the short description of an object. |
isEmpty | Method to determine, if the module contains any classes or functions. |
name | Method used to get the module name. |
shortDescription | Method used to get the short description of the module. |
Constructor
Private method to check, if the object to be documented contains a deprecated flag.
Method used to get the description of the module.
Private method to format the contents of the documentation string.
Private method to generate the section listing all classes of the module.
Private method to generate the document section with details about classes.
Private method to generate the list section of a description.
Method to generate the source code documentation.
Private method to generate the section listing all functions of the module.
Private method to generate the document section with details about functions.
Private method to generate a list section of the document.
Private method to generate the method details section.
Private method to generate the methods list section of a class.
Private method to generate the body of the document.
Private method to assemble the descriptive paragraphs of a docstring.
A paragraph is made up of a number of consecutive lines without an intermediate empty line. Empty lines are treated a paragraph delimiter.
Private method to generate the list section of a description.
Private method to generate the classes list section of a Ruby module.
Private method to generate the Ruby module classes details section.
Private method to generate the section listing all modules of the file (Ruby only).
Private method to generate the document section with details about Ruby modules.
Private method to determine the short description of an object.
The short description is just the first sentence (i.e. up to a '.' or empty line) of the documentation string.
Method to determine, if the module contains any classes or functions.
Method used to get the module name.
Method used to get the short description of the module.
The short description is just the first line of the modules description.
Exception class raised, if an invalid documentation tag was found.
TagError | Constructor |
Constructor