Package       Module       Class       Trees       Index       Help   
epydoc
[show private | hide private]

epydoc.objdoc
Class epydoc.objdoc.ObjDoc

Known Subclasses:
ModuleDoc, FuncDoc, ClassDoc
A base class for encoding the information about a Python object that is necessary to create its documentation. This base class defines the following documentation fields:
Method Summary
  __init__(self, obj, verbosity)
Create the documentation for the given object.
list of Element authors(self)
Return a list of the authors of the object documented by this ObjDoc.
Element descr(self)
Return a description of the object documented by this ObjDoc.
boolean documented(self)
Return true if the object documented by this ObjDoc has a docstring.
list of Element seealsos(self)
Return a list of objects related to the object documented by this ObjDoc.
list of string sortorder(self)
Return the object's __epydoc_sort__ list.
UID uid(self)
Return the UID of the object documented by this ObjDoc.
Element version(self)
Return the version of the object documented by this ObjDoc.

Method Details

Constructor

__init__(self, obj, verbosity=0)

Create the documentation for the given object.
Parameters:
obj - The object to document.
           (type=any)
verbosity - The verbosity of output produced when creating documentation for the object. More positive numbers produce more verbose output; negative numbers supress warnings and errors.
           (type=int)

authors

authors(self)

Returns:
A list of the authors of the object documented by this ObjDoc.
           (type=list of Element)

descr

descr(self)

Returns:
A description of the object documented by this ObjDoc.
           (type=Element)

documented

documented(self)

Returns:
True if the object documented by this ObjDoc has a docstring.
           (type=boolean)

seealsos

seealsos(self)

Returns:
A list of objects related to the object documented by this ObjDoc.
           (type=list of Element)

sortorder

sortorder(self)

Returns:
The object's __epydoc_sort__ list.
           (type=list of string)

uid

uid(self)

Returns:
The UID of the object documented by this ObjDoc.
           (type=UID)

version

version(self)

Returns:
The version of the object documented by this ObjDoc.
           (type=Element)

   Package       Module       Class       Trees       Index       Help   
epydoc
Generated by Epydoc on Sun Oct 6 03:32:14 2002 http://epydoc.sf.net