| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Module objdoc :: Class DocMap | 
 | 
UserDict --+
           |
          DocMap
DocMap using 
add, which adds an object and everything it contains. For 
example, the following code constructs a documentation map, adds the 
module "epydoc.epytext" to it, and looks up the documentation 
for "epydoc.epytext.parse":
>>> docmap = DocMap() # Construct a docmap >>> docmap.add(epydoc.epytext) # Add epytext to it >>> docmap[epydoc.epytext.parse] # Look up epytext.parse <FuncDoc: epydoc.epytext.parse (3 parameters; 1 exceptions)>
| Method Summary | |
|---|---|
| Create a new empty documentation map. | |
| ObjDoc | Return the documentation for the given object; or the object identified by key, ifkeyis aUID. | 
| __repr__(self) | |
| None | Add the documentation for an object, and everything contained by that object, to this documentation map. | 
| None | Add an object's documentation to this documentation map. | 
| ObjDocorNone | Returns the documentation for the closest ancestor of method_uidthat defines a docstring. | 
| sorted_keys(self) | |
| listofUID | Return the list of top-level objects documented by this documentation map. | 
| _add(self,
          objID) | |
| boolean | Return true if the object identified by uidis not contained (as 
a sub-package, module contents, class contents, etc.) by any other object 
in this docmap. | 
| Inherited from UserDict:__cmp__,__contains__,__delitem__,__len__,__setitem__,clear,copy,get,has_key,items,iteritems,iterkeys,itervalues,keys,popitem,setdefault,update,values | |
| Method Details | 
|---|
| __init__(self,
          verbosity=0,
          document_bases=1,
          document_autogen_vars=1,
          inheritance_groups=0,
          inherit_groups=1)
    Create a new empty documentation map. | 
| __getitem__(self,
          key)
     | 
| add(self, obj)Add the documentation for an object, and everything contained by that object, to this documentation map.
 | 
| add_one(self, objID)Add an object's documentation to this documentation map. If you also want to include the objects contained byobj, then useadd.
 | 
| documented_ancestor(self, method_uid)Returns the documentation for the closest ancestor ofmethod_uidthat defines a docstring. In particular, search 
  through the set of methods thatmethod_uidoverrides 
  (starting withmethod_uiditself), and return the first 
  method that:
 method_uiditself is 
  not documented by this docmap, then this function returnsNone. | 
| top(self)
 | 
| _toplevel(self, uid)
 | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:19 2004 | http://epydoc.sf.net |