yagdoc.linker.Linker

Package yagdoc :: Module linker :: Class Linker

[show private | hide private]

Type Linker

object --+
         |
        Linker

Map from symbol names to URIs.

Method Summary
	`__init__(self)`
	`add_index(self, lmap)` Add a link map.
	`add_index_file(self, filename, pkgname)` Add a link map from a file.
`(IndexItem, LinkMap)` or `(None, None)`	`get(self, xmlid)` Find item by its id.
	`_index_class_by_name(self, filename)`
Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__str__`

Instance Variable Summary
`list` of {LinkerError}	`errors`: Errors encountered, this includes errors of subordinate link maps.

Method Details

Add a link map.

Add a link map from a file.

The map type is determined automatically. If the map fails LinkMap.check_name sanity check, it is ignored.

Find item by its id.

Maps are searched sequentially, in the order they were added.

Returns:: A couple consisting of the item and the map it was found in, or a couple of Nones if the id was not found.
(type=(IndexItem, LinkMap) or (None, None))

Instance Variable Details

Errors encountered, this includes errors of subordinate link maps.

Generated by Epydoc 2.1 on Fri Oct 5 00:36:53 2007