epydoc.objdoc.PropertyDoc

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:

- fget: The property's get function
- fset: The property's set function
- fdel: The property's delete function
- type: The property's type

Method Summary
| `__init__(self, uid, typ, verbosity)`
| `__repr__(self)`
Accessors
`markup.ParsedDocstring` | ``type`(self)` Return a description of this property's type.
`UID` | ``fget`(self)` Return the UID of this property's get function.
`UID` | ``fset`(self)` Return the UID of this property's set function.
`UID` | ``fdel`(self)` 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`

Class Variable Summary
Docstring Parsing
Inherited from `ObjDoc`: `STANDARD_FIELDS`

Method Details

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

### 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`)

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

Generated by Epydoc 2.1 on Sat Mar 20 17:46:17 2004 | http://epydoc.sf.net