| Home | Trees | Index | Help |
|
|---|
| Package epydoc :: Package markup :: Module javadoc :: Class ParsedJavadocDocstring |
|
ParsedDocstring --+
|
ParsedJavadocDocstring
| Method Summary | |
|---|---|
Create a new ParsedJavadocDocstring. | |
Return a new parsed docstring containing the concatination of this docstring and other. | |
ParsedDocstring
|
Return a short summary of this docstring. |
string
|
Translate this docstring to plaintext. |
Make sure that all @{link}s are valid. | |
Inherited from ParsedDocstring:
__add__,
index_terms,
to_latex
| |
| Field Splitting | |
(
|
Split this docstring into its body and its fields. |
| HTML Output | |
string
|
Translate this docstring to HTML. |
| Class Variable Summary | |
|---|---|
| Field Splitting | |
list |
_ARG_FIELDS: A list of the fields that take arguments. |
SRE_Pattern |
_FIELD_RE: A regular expression used to search for Javadoc block tags. |
| HTML Output | |
SRE_Pattern |
_LINK_SPLIT_RE: A regular expression used to search for Javadoc inline tags. |
SRE_Pattern |
_LINK_RE: A regular expression used to process Javadoc inline tags. |
| Method Details |
|---|
split_fields(self, errors=None)Split this docstring into its body and its fields.
|
to_html(self, docstring_linker, **options)Translate this docstring to HTML.
|
__init__(self,
docstring,
errors=None)
Create a new |
concatenate(self, other)
|
summary(self)
|
to_plaintext(self, docstring_linker, **options)Translate this docstring to plaintext.
|
_check_links(self, errors)Make sure that all @{link}s are valid. We need a separate method for ths because we want to do this at parse time, not html output time. Any errors found are appended toerrors.
|
| Class Variable Details |
|---|
_FIELD_REA regular expression used to search for Javadoc block tags.
|
_LINK_SPLIT_REA regular expression used to search for Javadoc inline tags.
|
_LINK_REA regular expression used to process Javadoc inline tags.
|
| Home | Trees | Index | Help |
|
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:14 2004 | http://epydoc.sf.net |