Home       Trees       Index       Help   

epydoc 3.0alpha2

Package epydoc :: Package markup :: Class DocstringLinker
[hide private]
[frames] | no frames]

Class DocstringLinker
source code

A translator for crossreference links into and out of a ParsedDocstring. DocstringLinker is used by ParsedDocstring to convert these crossreference links into appropriate output formats. For example, DocstringLinker.to_html expects a DocstringLinker that converts crossreference links to HTML.

Instance Methods [hide private]
string translate_indexterm(self, indexterm)
Translate an index term to the appropriate output format.
string translate_identifier_xref(self, identifier, label=None)
Translate a crossreference link to a Python identifier to the appropriate output format.

Method Details [hide private]

translate_indexterm(self, indexterm)

source code 
Translate an index term to the appropriate output format. The output will typically include a crossreference anchor.
Parameters:
Returns: string
The translated index term.

translate_identifier_xref(self, identifier, label=None)

source code 
Translate a crossreference link to a Python identifier to the appropriate output format. The output will typically include a reference or pointer to the crossreference target.
Parameters:
  • identifier (string) - The name of the Python identifier that should be linked to.
  • label (string or None) - The label that should be used for the identifier, if it's different from the name of the identifier.
Returns: string
The translated crossreference link.

   Home       Trees       Index       Help   

epydoc 3.0alpha2

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