epydoc.apidoc.PropertyDoc

type PropertyDoc

API documentation information about a single property.

Instance Methods

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.) 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

Value Representation

Inherited from ValueDoc: pyval_repr, summary_pyval_repr

Instance Variables

[hide private]

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

ParsedDocstring

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

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.
overrides: Points from class variables to the variables they override. This filter is False by default.

Overrides: APIDoc.apidoc_links: (inherited documentation)

is_detailed(self)

source code
call graph

Does this object deserve a box with extra details?

Returns: bool: True if the object needs extra details, else False.
Overrides: APIDoc.is_detailed: (inherited documentation)