| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Module uid | 
 | 
UID class. It is important that each object 
have a single unique identifier, because one object may have more than 
one name. UIDs should be always created using the make_uid function; do not create UIDs 
directly. The Link class uses UIDs to implement 
crossreferencing between ObjDocs.
Bugs:
L{links}" that refer to the nested 
class using its normal name (e.g. 
ContainerClass.NestedClass) won't be resolved correctly. But 
you should be able to link to it with just NestedClass.
PropertyDoc usually creates an incorrect UID for its 
fget, fset, and fdel accessors. This arises because they are represented 
as functions, not methods; so epydoc doesn't have any way to tell what 
class they were defined in. As a result, it just assumes that they were 
installed at the module level. The effect of this bug is that the 
hyperlinks from property accessor methods don't point to the right 
targets.
  See Also: epydoc.objdoc
| Classes | |
|---|---|
| ObjectUID | A globally unique identifier used to refer to a Python object. | 
| Unique Identifiers | |
| UID | A globally unique identifier. | 
| RelativeUID | A globally unique identifier used to refer to a variable, relative to a Python object. | 
| VariableUID | |
| PropertyUID | |
| StaticMethodUID | |
| ClassMethodUID | |
| Crossreferences | |
| Link | A cross-reference link between documentation. | 
| Function Summary | |
|---|---|
| Create a globally unique identifier for the given object. | |
| UIDorNone | Attempt to find the UID for the object that can be accessed with the name namefrom the modulemodule. | 
| None | Reset the internal cache of UIDs for objects. | 
| Function Details | 
|---|
| make_uid(object, base_uid=None, shortname=None)Create a globally unique identifier for the given object. | 
| findUID(name, container=None, docmap=None)Attempt to find the UID for the object that can be accessed with the namenamefrom the modulemodule.
 | 
| reset_uid_cache()Reset the internal cache of UIDs for objects.
 | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:15 2004 | http://epydoc.sf.net |