HappyDoc Generated Documentation Class: RawTextConverter

HappyDoc3-r3_1 / happydoclib / docstring / docstring_RawText.py / RawTextConverter 

Raw (pass-through) docstring converter.

This converter does not modify its inputs in any way.

Base Classes   

RawTextConverter
  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,
        *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.

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