HappyDoc Generated Documentation Class: CodeObjectTree

HappyDoc3-r3_1 / happydoclib / packagetree.py / CodeObjectTree 

Represents a code object to be documented.

Base Classes   

CodeObjectTree
  PackageTree
    UserDict.UserDict

Methods   
  getInputFilename 
getInputFilename ( self )

Returns the input filename of the parent node.

  getRelativeFilename 
getRelativeFilename ( self )

Returns the filename of the parent node.

  getDocStringAndFormat 
getDocStringAndFormat ( self )

Returns the docstring of the code object, and the format of that data.

  getSummaryAndFormat 
getSummaryAndFormat ( self )

Returns a tuple containing a one line summary of the documentation for the node and the format of that string as understood by the docstring converter plugins.

  __init__ 
__init__ (
        self,
        parent,
        name,
        )

Construct a CodeObjectTree.

  getMimeType 
getMimeType ( self )

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