Package epydoc :: Module objdoc :: Class PropertyDoc
[show private | hide private]
[frames | no frames]

Class PropertyDoc

ObjDoc --+
         |
        PropertyDoc


The documentation for a property. This documentation consists of standard pieces of documentation (as defined in ObjDoc), and the following property-specific pieces of documentation:
Method Summary
  __init__(self, uid, typ, verbosity)
  __repr__(self)
    Accessors
UID fdel(self)
Return the UID of this property's delete function.
UID fget(self)
Return the UID of this property's get function.
UID fset(self)
Return the UID of this property's set function.
markup.ParsedDocstring type(self)
Return a description of this property's type.
Inherited from ObjDoc: by_group, defines_groups, descr, field_values, fields, groups, has_docstring, sortorder, summary, uid

Class Variable Summary
    Docstring Parsing
Inherited from ObjDoc: STANDARD_FIELDS

Method Details

fdel(self)

Returns:
The UID of this property's delete function.
           (type=UID)

fget(self)

Returns:
The UID of this property's get function.
           (type=UID)

fset(self)

Returns:
The UID of this property's set function.
           (type=UID)

type(self)

Returns:
A description of this property's type.
           (type=markup.ParsedDocstring)

Generated by Epydoc 2.0 on Tue Jul 22 04:20:30 2003 http://epydoc.sf.net