HappyDoc Generated Documentation Class: PlainTextConverter

HappyDoc3-r3_1 / happydoclib / docstring / docstring_PlainText.py / PlainTextConverter 

PlainText format converter.

This is not the same as the RawText converter, which is a pass-through converter. This converter will actually modify some output.

Base Classes   

PlainTextConverter
  happydoclib.happydocstring.HappyDocStringConverterBase

Methods   
  quote 
quote (
        self,
        inputText,
        outputFormat,
        *args,
        *namedArgs,
        )

Returns the inputText quoted in a way that special characters are escaped.

Parameters:
inputText
String or other sequence of characters to be converted. This string should be in the format advertised by the docstring converter.
outputFormat
String defined by the docstring converter class to represent a supported output scheme. This value is converter-specific, and not all converters will support the same output formats.
*args
Additional, converter-specific, positional arguments.
**namedArgs
Additional, converter-specific, named arguments.
  convert 
convert (
        self,
        inputText,
        outputFormat,
        level=3,
        *args,
        *namedArgs,
        )

Returns the inputText data translated into the outputFormat.

Parameters:
inputText
String or other sequence of characters to be converted. This string should be in the format advertised by the docstring converter.
outputFormat
String defined by the docstring converter class to represent a supported output scheme. This value is converter-specific, and not all converters will support the same output formats.
level=3
Beginning indention level for the text. This controls what type of header elements are created among other behaviors.
  _testOutputFormat 
_testOutputFormat ( self,  outputFormat )
Exceptions   

ValueError('Unrecognized output format "%s" for %s.' %( outputFormat, self.__class__.__name__, ) )


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