epydoc.apidoc.PropertyDoc

Class PropertyDoc

Instance Methods

apidoc_links(self, **filters)

source code
call graph

bool

is_detailed(self)
Does this object deserve a box with extra details?

source code
call graph

Inherited from ValueDoc: __getstate__, __repr__, __setstate__

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__

Value Representation

Inherited from ValueDoc: pyval_repr, summary_pyval_repr

Instance Variables

Inherited from ValueDoc: canonical_name, toktree

Property Access Functions

RoutineDoc

fget = _Sentinel('UNKNOWN')
API documentation for the property's get function.

RoutineDoc

fset = _Sentinel('UNKNOWN')
API documentation for the property's set function.

RoutineDoc

fdel = _Sentinel('UNKNOWN')
API documentation for the property's delete function.

Information Extracted from Docstrings

type_descr = _Sentinel('UNKNOWN')
A description of the property's expected type, extracted from its docstring.

Inherited from APIDoc: descr, extra_docstring_fields, metadata, other_docs, 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

Properties

Inherited from object: __class__

Does this object deserve a box with extra details?