__init__ (
        self,
        name,
        parent,
        filename,
        tree,
        commentInfo={},
        defaultConfigValues={},
        )

Initialize the info extractor.

Parameters:

name

name of this object

parent

parent object (e.g. Module for Class)

filename

file which contains the tree

tree

parse tree from which to extract information

commentInfo

comments extracted from source file where this object was found

_extractConfigurationValues ( self )

Default implementation does nothing.

_extractInfo ( self,  tree )

Pull information out of the parse tree.

_extractSummary ( self,  text )

Extract a summary text from a larger body.

getConfigurationValues ( self )

Return any HappyDoc configuration values related to this object.

getDocString ( self )

Return any __doc__ string value found for the object.

getDocStringFormat ( self )

Returns the docstring converter format name for the docstring for this object.

getSummaryAndFormat ( self )

Return a summary of the __doc__ string for this object and the docstring converter name for the format of the text.