| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Module objdoc :: Class ClassDoc | 
 | 
ObjDoc --+
         |
        ClassDoc
ObjDoc), and the following class-specific 
pieces of documentation:
| Method Summary | |
|---|---|
| __init__(self,
          uid,
          verbosity) | |
| __repr__(self) | |
| Inherited from ObjDoc:_sort | |
| Accessors | |
| boolean | Return true if this ClassDocdocuments an exception class. | 
| listofLink | Return a list of all (instance) methods defined by the class documented by this ClassDoc, sorted by name. | 
| listofLink | Return a list of all class methods defined by the class documented by this ClassDoc, sorted by name. | 
| listofLink | Return a list of all static methods defined by the class documented by this ClassDoc, sorted by name. | 
| listofLink | Return a list of all properties defined by the class documented by this ClassDoc, sorted by name. | 
| listofLink | Return a list of all instance, class, and static methods defined by the class documented by this ClassDoc, sorted by name. | 
| listofVar | Return a list of all class variables defined by the class documented by this ClassDoc, sorted by name. | 
| listofVar | Return a list of all instance variables defined by the class documented by this ClassDoc, sorted by name. | 
| listofLink | Return a list of all base classes for the class documented by this ClassDoc, sorted by name. | 
| listofLink | Return a list of known subclasses for the class documented by this ClassDoc, sorted by name. | 
| markup.ParsedDocstringorNone | Return the type for the given property, as specified by the docstring of the class documented by this ClassDoc. | 
| listofUID | Return a list of all base ancestors of the class documented by this ClassDoc, listed in the order that they are searched byPythonfor members. | 
| Inherited from ObjDoc:by_group,defines_groups,descr,field_values,fields,groups,has_docstring,sortorder,summary,uid | |
| Inheritance | |
| None | Register subclasses for the class doumented by this ClassDoc. | 
| None | Add inherited variables and groups to this ClassDoc. | 
| None | Add inherited class and instance variables to this ClassDoc. | 
| None | Inherit groups from the given list of ClassDocs. | 
| For each base class that this class inherits from, create a group that includes all methods, properties, and variables that were inherited from that base. | |
| Error Handling | |
| Inherited from ObjDoc:_print_errors | |
| Docstring Parsing | |
| Process a field from this object's docstring. | |
| Instance Variable Summary | |
|---|---|
| listofLink | _bases: A list of the identifiers of this class's bases. | 
| listofVar | _cvariables: A list of all class variables defined by this class. | 
| listofVar | _ivariables: A list of all instance variables defined by this class. | 
| listofLink | _methods: A list of all methods contained in this class. | 
| Inherited from ObjDoc:_uid | |
| Error Handling | |
| Inherited from ObjDoc:_field_warnings,_misc_warnings,_parse_errors,_parse_warnings | |
| Docstring Parsing | |
| Inherited from ObjDoc:_descr,_fields | |
| Class Variable Summary | |
|---|---|
| Docstring Parsing | |
| Inherited from ObjDoc:STANDARD_FIELDS | 
| Method Details | 
|---|
| is_exception(self)
 | 
| methods(self)
 | 
| classmethods(self)
 | 
| staticmethods(self)
 | 
| properties(self)
 | 
| allmethods(self)
 | 
| cvariables(self)
 | 
| ivariables(self)
 | 
| bases(self)
 | 
| subclasses(self)
 | 
| property_type(self, uid)
 | 
| base_order(self)
 | 
| add_subclasses(self, classes)Register subclasses for the class doumented by thisClassDoc. This must be done externally, since we can't 
  determine a class's subclasses through introspection alone. This is 
  automatically called byDocMap.addwhen new classes are added to 
  aDocMap.
 | 
| inherit(self, base_docs, inheritance_groups, inherit_groups)Add inherited variables and groups to thisClassDoc. To 
  search for inherited variables and groups,inherituses a 
  list of the documentation objects for every base ancestor of the class 
  documented by thisClassDoc. Typical usage is:
>>> doc.inherit([docmap[b] for b in doc.base_order()])
 | 
| _inherit_vars(self, base_docs)Add inherited class and instance variables to thisClassDoc. To search for inherited variables,inherit_varsuses a list of the documentation objects for 
  every base ancestor of the class documented by thisClassDoc.
 | 
| _inherit_groups(self, base_docs)Inherit groups from the given list ofClassDocs. These 
  should be theClassDocs for the classes returned bybase_order, in the order that they are 
  returned bybase_order.
 | 
| _add_inheritance_groups(self)For each base class that this class inherits from, create a group that includes all methods, properties, and variables that were inherited from that base. | 
| _process_field(self, tag, arg, descr, warnings)Process a field from this object's docstring.ObjDoc._process_fieldbe overridden by child classes ofObjDoc, and called as the default case.
 | 
| Instance Variable Details | 
|---|
| _basesA list of the identifiers of this class's bases.
 | 
| _cvariablesA list of all class variables defined by this class.
 | 
| _ivariablesA list of all instance variables defined by this class.
 | 
| _methodsA list of all methods contained in this class.
 | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:16 2004 | http://epydoc.sf.net |