Home       Trees       Index       Help   

epydoc 3.0alpha2

Package epydoc :: Package markup :: Module plaintext :: Class ParsedPlaintextDocstring
[hide private]
[frames] | no frames]

Class ParsedPlaintextDocstring
source code

Instance Methods [hide private]
  __init__(self, text, **options)
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.
ParsedDocstring summary(self)

Inherited from ParsedDocstring: __add__, concatenate, index_terms, split_fields


Method Details [hide private]

__init__(self, text, **options)
(Constructor)

source code 
call graph 

to_html(self, docstring_linker, **options)

source code 
call graph 
Translate this docstring to HTML.
Returns: string
An HTML fragment that encodes this docstring.
Overrides: ParsedDocstring.to_html
(inherited documentation)

to_latex(self, docstring_linker, **options)

source code 
Translate this docstring to LaTeX.
Returns: string
A LaTeX fragment that encodes this docstring.
Overrides: ParsedDocstring.to_latex
(inherited documentation)

to_plaintext(self, docstring_linker, **options)

source code 
call graph 
Translate this docstring to plaintext.
Returns: string
A plaintext fragment that encodes this docstring.
Overrides: ParsedDocstring.to_plaintext
(inherited documentation)

summary(self)

source code 
call graph 
Returns: ParsedDocstring
A short summary of this docstring. Typically, the summary consists of the first sentence of the docstring.
Overrides: ParsedDocstring.summary
(inherited documentation)

   Home       Trees       Index       Help   

epydoc 3.0alpha2

Generated by Epydoc 3.0alpha2 on Tue Apr 11 17:37:21 2006 http://epydoc.sf.net