| Home | Trees | Index | Help |
|
|---|
| Package epydoc :: Package markup :: Class ParsedDocstring |
|
ParsedEpytextDocstring,
ParsedJavadocDocstring,
ParsedPlaintextDocstring,
ParsedRstDocstringepytext.parse or javadoc.parse).
ParsedDocstrings support several kinds of operation:
to_plaintext(), to_html(), and to_latex()).
summary()).
split_fields()).
index_terms().
to_format()) use a DocstringLinker to link the docstring
output with the rest of the documentation that epydoc generates.
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).
to_format methods will be added to this base class;
but they will always be given a default implementation.
| Method Summary | |
|---|---|
__add__(self,
other)
| |
Return a new parsed docstring containing the concatination of this docstring and other. | |
list of ParsedDocstring
|
Return the list of index terms that are defined in this docstring. |
(
|
Split this docstring into its body and its fields. |
ParsedDocstring
|
Return a short summary of this docstring. |
string
|
Translate this docstring to HTML. |
string
|
Translate this docstring to LaTeX. |
string
|
Translate this docstring to plaintext. |
| Method Details |
|---|
concatenate(self, other)
|
index_terms(self)
|
split_fields(self, errors=None)Split this docstring into its body and its fields.
|
summary(self)
|
to_html(self, docstring_linker, **options)Translate this docstring to HTML.
|
to_latex(self, docstring_linker, **options)Translate this docstring to LaTeX.
|
to_plaintext(self, docstring_linker, **options)Translate this docstring to plaintext.
|
| Home | Trees | Index | Help |
|
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:17 2004 | http://epydoc.sf.net |