yagdoc.linker.LinkMap

Package yagdoc :: Module linker :: Class LinkMap

[show private | hide private]

Type LinkMap

object --+
         |
        LinkMap

Abstract base class for link maps.

Subclasses must implement scan() method used to read the index.

Method Summary
	`__init__(self, name, source)` Create a new link map.
	`add_item(self, item, xmlid)` Add an item to index.
`bool`	`check_name(self)` Check whether the package name of a link map looks sane.
Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__str__`

Instance Variable Summary
`list` of {LinkerError}	`errors`: Errors encountered.

Method Details

Create a new link map.

Parameters:: source - Index, its name attribute will be used as the source name (if set). It can be a file or any other iterable returning strings.
(type=iterable of str)

Add an item to index.

Parameters:: item - Item to add.
(type=IndexItem); xmlid - Element id serving as the item key (if it differs from item.fragment.
(type=str)

Check whether the package name of a link map looks sane.

If the name looks bad, this particularly means names such as 'docs' or 'reference', an error is added to errors.

Instance Variable Details

Errors encountered. Note in the usual mode of operation link map errors are gathered by the Linker and removed from individual link maps.

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