epydoc.apidoc.PropertyDoc

Package epydoc :: Module apidoc :: Class PropertyDoc

Class PropertyDoc
source code

API documentation information about a single property.

Instance Methods	[hide private]

apidoc_links(self, **filters)
Return a list of all APIDocs that are directly linked from this APIDoc (i.e., are contained or pointed to by one or more of this APIDoc's attributes.)

Inherited from ValueDoc: __repr__, pyval_repr

Inherited from APIDoc: __cmp__, __hash__, __init__, __setattr__, __str__, merge_and_overwrite, pp, specialize_to

Inherited from APIDoc (private): _debug_setattr

Inherited from object: __delattr__, __getattribute__, __new__, __reduce__, __reduce_ex__

Class Variables	[hide private]

Inherited from object: __class__

Instance Variables	[hide private]

Inherited from ValueDoc: canonical_name, toktree

Property Access Functions

fget API documentation for the property's get function.

fset API documentation for the property's set function.

fdel API documentation for the property's delete function.

Information Extracted from Docstrings

type_descr A description of the property's expected type, extracted from its docstring.

Inherited from APIDoc: descr, extra_docstring_fields, metadata, summary

Value Representation

Inherited from ValueDoc: parse_repr, pyval

Context

Inherited from ValueDoc: defining_module

Information about Imported Variables

Inherited from ValueDoc: proxy_for

Docstrings

Inherited from APIDoc: docstring, docstring_lineno

Source Information

Inherited from APIDoc: docs_extracted_by

Method Details	[hide private]

apidoc_links(self, **filters)

source code
call graph

Return a list of all APIDocs that are directly linked from this APIDoc (i.e., are contained or pointed to by one or more of this APIDoc's attributes.)

Keyword argument filters can be used to selectively exclude certain categories of attribute value. For example, using includes=False will exclude variables that were imported from other modules; and subclasses=False will exclude subclasses. The filter categories currently supported by epydoc are:

imports: Imported variables.
packages: Containing packages for modules.
submodules: Contained submodules for packages.
bases: Bases for classes.
subclasses: Subclasses for classes.
variables: All variables.
private: Private variables.