lemon.external.epydoc.markup.plaintext.ParsedPlaintextDocstring

Package lemon :: Package external :: Package epydoc :: Package markup :: Module plaintext :: Class ParsedPlaintextDocstring

[show private | hide private]

Class ParsedPlaintextDocstring

ParsedDocstring --+
                  |
                 ParsedPlaintextDocstring

Method Summary
	`__init__(self, text, **options)`
`ParsedDocstring`	`summary(self)` Return a short summary of this docstring.
`string`	`to_html(self, docstring_linker, **options)` Translate this docstring to HTML.
`string`	`to_latex(self, docstring_linker, **options)` Translate this docstring to LaTeX.
`string`	`to_plaintext(self, docstring_linker, **options)` Translate this docstring to plaintext.
Inherited from ParsedDocstring
`list` of `ParsedDocstring`	`index_terms(self)` Return the list of index terms that are defined in this docstring.
`(ParsedDocstring, list of Field)`	`split_fields(self, errors)` Split this docstring into its body and its fields.

Method Details

Returns:: A short summary of this docstring. Typically, the summary consists of the first sentence of the docstring.
(type=ParsedDocstring)

Overrides:: epydoc.markup.ParsedDocstring.summary (inherited documentation)

Translate this docstring to HTML.

Parameters:: docstring_linker - An HTML translator for crossreference links into and out of the docstring.
(type=DocstringLinker); options - Any extra options for the output. Unknown options are ignored.

Overrides:: epydoc.markup.ParsedDocstring.to_html (inherited documentation)

Translate this docstring to LaTeX.

Parameters:: docstring_linker - A LaTeX translator for crossreference links into and out of the docstring.
(type=DocstringLinker); options - Any extra options for the output. Unknown options are ignored.

Overrides:: epydoc.markup.ParsedDocstring.to_latex (inherited documentation)

Translate this docstring to plaintext.

Parameters:: docstring_linker - A plaintext translator for crossreference links into and out of the docstring.
(type=DocstringLinker); options - Any extra options for the output. Unknown options are ignored.

Returns:: A plaintext fragment that encodes this docstring.
(type=string)

Overrides:: epydoc.markup.ParsedDocstring.to_plaintext (inherited documentation)

Generated by Epydoc 2.0 on Mon Nov 10 15:07:39 2003