HappyDoc Generated Documentation Class: StructuredTextFile

HappyDoc3-r3_1 / happydoclib / parsers / parsers_structuredtext.py / StructuredTextFile 

Structured text file node.

Base Classes   

StructuredTextFile
  PackageTree

Methods   
  getDocStringAndFormat 
getDocStringAndFormat ( self )

Returns a tuple containing the actual documentation string and the format of that docstring as understood by the docstring converters plugins.

  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,
        )

This document was automatically generated Tue Dec 5 08:30:28 2006 by HappyDoc version 3.1