| Home | Trees | Index | Help |
|
|---|
| Package epydoc :: Module objdoc :: Class PropertyDoc |
|
ObjDoc --+
|
PropertyDoc
ObjDoc), and the following
property-specific pieces of documentation:
| Method Summary | |
|---|---|
__init__(self,
uid,
typ,
verbosity)
| |
__repr__(self)
| |
Return a UID for the given fget/fset/fdel function of the property. | |
Inherited from ObjDoc:
_sort
| |
| Accessors | |
markup.ParsedDocstring
|
Return a description of this property's type. |
UID
|
Return the UID of this property's get function. |
UID
|
Return the UID of this property's set function. |
UID
|
Return the UID of this property's delete function. |
Inherited from ObjDoc:
by_group,
defines_groups,
descr,
field_values,
fields,
groups,
has_docstring,
sortorder,
summary,
uid
| |
| Error Handling | |
Inherited from ObjDoc:
_print_errors
| |
| Docstring Parsing | |
Process a field from this object's docstring. | |
| Instance Variable Summary | |
|---|---|
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 |
|---|
type(self)
|
fget(self)
|
fset(self)
|
fdel(self)
|
_make_uid(self, func, cls, functype)Return a UID for the given fget/fset/fdel function of the property. This is a heuristic function, which first looks for the function within the current class (and its ancestors); and then looks for it as a module-level function. If the function is actually defined somewhere else (e.g., in an unrelated class), then it will be mistakenly interpreted as a module- level function.
|
_process_field(self, tag, arg, descr, warnings)Process a field from this object's docstring.ObjDoc._process_field be overridden by child classes of
ObjDoc, and called as the default case.
|
| Home | Trees | Index | Help |
|
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:17 2004 | http://epydoc.sf.net |