epydoc.uid.Link

Package	Module	Class	Trees	Index	Help

epydoc

[show private | hide private]

epydoc.uid
Class epydoc.uid.Link

A cross-reference link between documentation. A link consists of a name and a target. The target is a UID, identifying the object whose documentation is pointed to. The name specifies how the link should appear in the source document. Usually, the name is just the (short) name of the target. However, it doesn't have to be. For example, consider the following code:

>>> def f(x): pass
>>> g = f

Links to g and f will have the same target (whose short name will be 'f'), but links to them will use different names ('f' and 'g', respectively).

Method Summary
	`__init__(self, name, target)` Create a new cross-reference link, with the given name and target.
	`__cmp__(self, other)`
`string`	`__repr__(self)` Return a string representation of this `Link`.
`string`	`name(self)` Return this link's name.
`UID`	`target(self)` Return this link's target.

Method Details

Constructor

__init__(self, name, target)

Create a new cross-reference link, with the given name and target.

Parameters:: name - A string specifying how the link should appear in the source document.
(type=string); target - The object that is pointed to by the new Link.
(type=UID)

Comparison operator

__cmp__(self, other)

Representation operator

__repr__(self)

Returns:: A string representation of this Link.
(type=string)

name

name(self)

Returns:: This link's name. This string specifies how the link should appear in the source document.
(type=string)

target

target(self)

Returns:: This link's target. This UID specifies what object is pointed to by this link.
(type=UID)

Package	Module	Class	Trees	Index	Help

epydoc

Generated by Epydoc on Sun Oct 6 03:32:15 2002