| Method Summary |
| |
__init__(self,
docstring,
errors)
Create a new ParsedJavadocDocstring. |
| |
concatenate(self,
other)
Return a new parsed docstring containing the concatination of this docstring
and other. |
ParsedDocstring
|
summary(self)
Return a short summary of this docstring. |
string
|
to_plaintext(self,
docstring_linker,
**options)
Translate this docstring to plaintext. |
Inherited from ParsedDocstring:
__add__,
index_terms,
to_latex
|
| Field Splitting |
(ParsedDocstring, list of Field)
|
split_fields(self,
errors)
Split this docstring into its body and its fields. |
| HTML Output |
string
|
to_html(self,
docstring_linker,
**options)
Translate this docstring to HTML. |