HappyDoc Generated Documentation Class: ModuleInfo

HappyDoc3-r3_1 / happydoclib / parseinfo / moduleinfo.py / ModuleInfo 

Information gatherer for source code modules.

Extract information about a source module from its parse tree.

Base Classes   

ModuleInfo
  SuiteInfoBase
  SuiteFuncInfo

Methods   
  getClassNames 
getClassNames ( self )

Return the names of classes defined within the module.

  _extractImportedModules 
_extractImportedModules ( self,  tree )

Returns modules imported by code in tree.

Scan the parse tree for import statements and return the names of all modules imported.

  getReferenceTargetName 
getReferenceTargetName ( self )

Return the name to use as a target for a reference such as a hyperlink.

  _extractConfigurationValues 
_extractConfigurationValues ( self,  matchConfigValue=re.compile( '^#\s*HappyDoc:(.+)$', re.IGNORECASE ).match )

Look into the module source file and extract HappyDoc configuration values.

Variables can be embedded in the first comment block of the module.

  getCommentKey 
getCommentKey ( self )
  getClassInfo 
getClassInfo ( self,  name )

Return a ClassInfo object for the class by name.

  getImportData 
getImportData ( self )

Returns a list of which symbols are imported.

  __init__ 
__init__ (
        self,
        parent,
        tree,
        name="",
        fileName=None,
        commentInfo={},
        defaultConfigValues={},
        )

Initialize the info extractor.

Parameters:
tree
parse tree from which to extract information
name
name of the module
fileName
name of the file containing the module
commentInfo
comments extracted from the file

This document was automatically generated Tue Dec 5 08:31:01 2006 by HappyDoc version 3.1