|
Base class for docstring converters.
|
Methods
|
|
__init__
convert
getExternalDocumentationFile
quote
|
|
|
__init__
|
__init__ ( self, **extraNamedParameters )
Initialize the docstring converter.
Parameters:
-
extraNamedParameters
- Parameters specified by name which
were not interpreted by a subclass initialization.
|
|
|
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.
-
*args
- Additional, converter-specific, positional arguments.
-
**namedArgs
- Additional, converter-specific, named arguments.
|
Exceptions
|
|
ValueError( '%s does not implement convert' % self.__class__.__name__ )
|
|
|
|
getExternalDocumentationFile
|
getExternalDocumentationFile (
self,
filename,
*args,
*namedArgs,
)
Returns the inputText quoted in a way that special characters are escaped.
Parameters:
-
filename
- Name of the file to retrieve.
-
*args
- Additional, converter-specific, positional arguments.
-
**namedArgs
- Additional, converter-specific, named arguments.
|
|
|
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.
|
Exceptions
|
|
ValueError( '%s does not implement quote' % self.__class__.__name__ )
|
|
|