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

epydoc.objdoc
Class epydoc.objdoc.ClassDoc

ObjDoc --+
         |
        ClassDoc

The documentation for a class. This documentation consists of standard documentation fields (descr, author, etc.) and the following class-specific fields: For more information on the standard documentation fields, see ObjDoc.
Method Summary
  __init__(self, obj, verbosity)
Create the documentation for the given object.
  __repr__(self)
None add_subclass(self, cls)
Register a subclass for the class doumented by this CClassDoc.
list of Element authors(self)
Return a list of the authors of the object documented by this ObjDoc. (inherited from ObjDoc)
list of Link bases(self)
Return a list of all base classes for the class documented by this ClassDoc.
list of Var cvariables(self)
Return a list of all class variables defined by the class documented by this ClassDoc.
Element descr(self)
Return a description of the object documented by this ObjDoc. (inherited from ObjDoc)
boolean documented(self)
Return true if the object documented by this ObjDoc has a docstring. (inherited from ObjDoc)
boolean is_exception(self)
Return true if this ClassDoc documents an exception class.
list of Var ivariables(self)
Return a list of all instance variables defined by the class documented by this ClassDoc.
list of Link methods(self)
Return a list of all methods defined by the class documented by this ClassDoc.
list of Element seealsos(self)
Return a list of objects related to the object documented by this ObjDoc. (inherited from ObjDoc)
list of string sortorder(self)
Return the object's __epydoc_sort__ list. (inherited from ObjDoc)
list of Link subclasses(self)
Return a list of known subclasses for the class documented by this ClassDoc.
UID uid(self)
Return the UID of the object documented by this ObjDoc. (inherited from ObjDoc)
Element version(self)
Return the version of the object documented by this ObjDoc. (inherited from ObjDoc)

Method Details

Constructor

__init__(self, cls, verbosity=0)

Overrides:
epydoc.objdoc.ObjDoc.__init__

Representation operator

__repr__(self)

add_subclass

add_subclass(self, cls)

Register a subclass for the class doumented by this CClassDoc. This must be done externally, since we can't determine a class's subclasses through introspection alone. This is automatically called by DocMap.add when new classes are added to a DocMap.
Parameters:
cls - The unique identifier of the subclass.
           (type=UID)
Returns:
None

bases

bases(self)

Returns:
A list of all base classes for the class documented by this ClassDoc.
           (type=list of Link)

cvariables

cvariables(self)

Returns:
A list of all class variables defined by the class documented by this ClassDoc.
           (type=list of Var)

is_exception

is_exception(self)

Returns:
True if this ClassDoc documents an exception class.
           (type=boolean)

ivariables

ivariables(self)

Returns:
A list of all instance variables defined by the class documented by this ClassDoc.
           (type=list of Var)

methods

methods(self)

Returns:
A list of all methods defined by the class documented by this ClassDoc.
           (type=list of Link)

subclasses

subclasses(self)

Returns:
A list of known subclasses for the class documented by this ClassDoc.
           (type=list of Link)

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