| Method Summary |
| |
__init__(self,
uid,
verbosity)
|
| |
__repr__(self)
|
|
|
| Accessors |
boolean
|
is_exception(self)
Return true if this ClassDoc documents an exception class. |
list of Link
|
methods(self)
Return a list of all (instance) methods defined by the class documented by
this ClassDoc, sorted by name. |
list of Link
|
classmethods(self)
Return a list of all class methods defined by the class documented by this
ClassDoc, sorted by name. |
list of Link
|
staticmethods(self)
Return a list of all static methods defined by the class documented by this
ClassDoc, sorted by name. |
list of Link
|
properties(self)
Return a list of all properties defined by the class documented by this
ClassDoc, sorted by name. |
list of Link
|
allmethods(self)
Return a list of all instance, class, and static methods defined by the class
documented by this ClassDoc, sorted by name. |
list of Var
|
cvariables(self)
Return a list of all class variables defined by the class documented by this
ClassDoc, sorted by name. |
list of Var
|
ivariables(self)
Return a list of all instance variables defined by the class documented by
this ClassDoc, sorted by name. |
list of Link
|
bases(self)
Return a list of all base classes for the class documented by this
ClassDoc, sorted by name. |
list of Link
|
subclasses(self)
Return a list of known subclasses for the class documented by this
ClassDoc, sorted by name. |
markup.ParsedDocstring or
None
|
property_type(self,
uid)
Return the type for the given property, as specified by the docstring of the
class documented by this ClassDoc. |
list of UID
|
base_order(self)
Return a list of all base ancestors of the class documented by this
ClassDoc, listed in the order that they are searched by
Python for members. |
Inherited from ObjDoc:
by_group,
defines_groups,
descr,
field_values,
fields,
groups,
has_docstring,
sortorder,
summary,
uid
|
| Inheritance |
None
|
add_subclasses(self,
classes)
Register subclasses for the class doumented by this
ClassDoc. |
None
|
inherit(self,
base_docs,
inheritance_groups,
inherit_groups)
Add inherited variables and groups to this ClassDoc. |