Package epydoc :: Package docwriter :: Module html :: Class _HTMLDocstringLinker |
[hide private]
[frames] | no frames]

# Class _HTMLDocstringLinker

source code

Instance Methods | [hide private]
__init__(self, htmlwriter, container) | source code call graph
Call Graph
`string` |
translate_indexterm(self, indexterm) Translate an index term to the appropriate output format. | source code call graph
Call Graph
`string` |
translate_identifier_xref(self, identifier, label=None) Translate a crossreference link to a Python identifier to the appropriate output format. | source code call graph
Call Graph
url_for(self, identifier) | source code call graph
Call Graph
_failed_xref(self, identifier) Add an identifier to the htmlwriter's failed crossreference list. | source code call graph
Call Graph

Method Details | [hide private]

### translate_indexterm(self, indexterm) | source code call graph
Call Graph
Translate an index term to the appropriate output format. The output will typically include a crossreference anchor. Parameters: `indexterm` - The index term to translate. Returns: `string` The translated index term. Overrides: markup.DocstringLinker.translate_indexterm (inherited documentation)

### translate_identifier_xref(self, identifier, label=None) | source code call graph
Call Graph
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` - The name of the Python identifier that should be linked to. `label` - 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. Overrides: markup.DocstringLinker.translate_identifier_xref (inherited documentation)