Table of Contents

Class: FileBasedFormatter HappyDoc-r0_7_1/formatter/formatter_file.py

Output documentation to file(s).

Base Classes   
happyformatter.HappyFormatterBase
Methods   
closeOutput
getFullOutputNameForObject
getLocalOutputNameForObject
getOutputNameForObject
getRootNodeName
openOutput
  closeOutput 
closeOutput ( self,  output )

Close the output handle.

  getFullOutputNameForObject 
getFullOutputNameForObject ( self,  infoObject )

Get the full name, including path, to the object being output.

  getLocalOutputNameForObject 
getLocalOutputNameForObject ( self,  infoObject )

Return a local reference to base name of the thing to which output should be written for an info source. This is usually a file name, but could be anything understood by the formatter as a name. If infoObject is None, return the name for a root node for this formatter.

  getOutputNameForObject 
getOutputNameForObject ( self,  infoObject )

Return the base name of the thing to which output should be written for an info source. This is usually a file name, but could be anything understood by the formatter as a name. If infoObject is None, return the name for a root node for this formatter.

  getRootNodeName 
getRootNodeName ( self )

Return the name of the root node for the documentation tree.

  openOutput 
openOutput (
        self,
        name,
        title1,
        title2=None,
        )

Open the named output destination and give the title.


Table of Contents

This document was automatically generated on Sat Sep 9 20:27:32 2000 by HappyDoc version r0_7_1