| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Module objdoc :: Class ObjDoc | 
 | 
ClassDoc,
    FuncDoc,
    ModuleDoc,
    PropertyDocObjDoc.STANDARD_FIELDS; but the user 
    may also add new generic docstring fields (via 
    @newfield or 
    __extra_epydoc_fields__).
  @sort 
    field.
  | Method Summary | |
|---|---|
| Create the documentation for the given object. | |
| __include(self,
          docstring) | |
| Return a copy of the list items, sorted first bysortorder, and then by name. | |
| Accessors | |
| UID | Return the UID of the object documented by this ObjDoc. | 
| markup.ParsedDocstring | Return a description of the object documented by this ObjDoc. | 
| listofDocField | Return a list of the fields that are given values in the docstring of the object documented by this ObjDoc. | 
| listofmarkup.ParsedDocstring | Return a list of the values that are specified for the given field in the docstring of the object documented by this ObjDoc. | 
| listofstring | Return a list specifying the sort order that should be used for the object's children. | 
| listofstring | Return a list of the names of the groups that are defined for the object documented by this ObjDoc. | 
| listof(string, elt) | Divide a set of elements into groups. | 
| boolean | Return true if the object documented by this ObjDochas a 
docstring. | 
| markup.ParsedDocstring | Return a summary of the description of the object documented by this ObjDoc. | 
| boolean | Return true if the object documented by this ObjDocdefines any 
groups. | 
| Error Handling | |
| None | Print any errors that were encountered while constructing this ObjDoctostream. | 
| Docstring Parsing | |
| __parse_docstring(self,
          docstring) | |
| Process a field from this object's docstring. | |
| Instance Variable Summary | |
|---|---|
| UID | _uid: The object's unique identifier | 
| Error Handling | |
| _parse_warnings: Warnings generated when parsing the object's docstring. | |
| _parse_errors: Errors generated when parsing the object's docstring. | |
| _field_warnings: Warnings generated when processing the object's docstring's 
fields. | |
| _misc_warnings: Warnings that are not related to the object's docstring. | |
| Docstring Parsing | |
| markup.ParsedDocstring | _descr: The object's description, encoded as epytext. | 
| dictionaryfromDocFieldtolistofmarkup.ParsedDocstring | _fields: Documentation fields that were extracted from the object's 
docstring. | 
| Class Variable Summary | |
|---|---|
| Docstring Parsing | |
| ListofDocField | STANDARD_FIELDS: The list of standard docstring fields that epydoc accepts. | 
| Method Details | 
|---|
| uid(self)
 | 
| descr(self)
 | 
| fields(self)
 | 
| field_values(self, field)
 | 
| sortorder(self)
 | 
| groups(self)
 | 
| by_group(self, elts)Divide a set of elements into groups. Typical usage:
>>> grouped_funcs = fdoc.by_group(fdoc.functions())
>>> for (group, members) in grouped_funcs:
...     print group, members
 | 
| has_docstring(self)
 | 
| summary(self)
 | 
| defines_groups(self)
 | 
| _print_errors(self, stream=None)Print any errors that were encountered while constructing thisObjDoctostream. This method should be 
  called at the end of the constructor of every class that is derived 
  fromObjDoc(after the baseObjDocconstructor has been called).
 | 
| _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.
 | 
| __init__(self,
          uid,
          verbosity=0,
          docstring=None)
    Create the documentation for the given object. | 
| _sort(self, items) | 
| Instance Variable Details | 
|---|
| _parse_warningsWarnings generated when parsing the object's docstring. | 
| _parse_errorsErrors generated when parsing the object's docstring. | 
| _field_warningsWarnings generated when processing the object's docstring's fields. | 
| _misc_warningsWarnings that are not related to the object's docstring. | 
| _descrThe object's description, encoded as epytext.
 | 
| _fieldsDocumentation fields that were extracted from the object's docstring. The list of fields that are accepted by epydoc is defined bySTANDARD_FIELDS.
 | 
| _uidThe object's unique identifier
 | 
| Class Variable Details | 
|---|
| STANDARD_FIELDSThe list of standard docstring fields that epydoc accepts. The order of fields is significant: when the fields are rendered, they will be listed in the order that they are given in this list. Note that this list does not include special fields, such as "group"; it just includes "simple" fields, which contain a single textual description or a list of textual descriptions.
 | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:17 2004 | http://epydoc.sf.net |