| Home | Trees | Indices | Help |
|
|---|
|
|
A standard intermediate representation for parsed docstrings that can
be used to generate output. Parsed docstrings are produced by markup
parsers (such as epytext.parse or javadoc.parse).
ParsedDocstrings support several kinds of operation:
The output generation methods (to_format()) use a DocstringLinker to link the docstring output with the
rest of the documentation that epydoc generates.
The only method that a subclass is required to implement is to_plaintext(); but it is often useful to override the other methods. The default behavior of each method is described below:
to_format: Calls to_plaintext, and
uses the string it returns to generate verbatim output.
summary: Returns self (i.e., the entire
docstring).
split_fields: Returns (self, []) (i.e.,
extracts no fields).
index_terms: Returns [] (i.e., extracts
no index terms).
If and when epydoc adds more output formats, new
to_format methods will be added to this base class;
but they will always be given a default implementation.
|
|||
(ParsedDocstring, list of Field)
|
|
||
(ParsedDocstring, bool)
|
|
||
|
|||
|
|||
string
|
|
||
string
|
|
||
string
|
|
||
list of ParsedDocstring
|
|
||
|
|||
Split this docstring into its body and its fields.
|
|
|
Translate this docstring to HTML.
|
Translate this docstring to LaTeX.
|
Translate this docstring to plaintext.
|
|
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0.1 on Wed Jan 30 14:08:27 2008 | http://epydoc.sourceforge.net |