Package epydoc :: Module apidoc :: Class GenericValueDoc
[hide private]
[frames] | no frames]

Class GenericValueDoc

source code


API documentation about a 'generic' value, i.e., one that does not have its own docstring or any information other than its value and parse representation. GenericValueDocs do not get assigned cannonical names.

Instance Methods [hide private]
bool
is_detailed(self)
Does this object deserve a box with extra details?
source code

Inherited from ValueDoc: __getstate__, __repr__, __setstate__, apidoc_links

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

Class Variables [hide private]
DottedName canonical_name = True
A dotted name that serves as a unique identifier for this ValueDoc's value.
    Value Representation

Inherited from ValueDoc: REPR_LINELEN, REPR_MAXLINES, REPR_MIN_SCORE, SUMMARY_REPR_LINELEN

Instance Variables [hide private]

Inherited from ValueDoc: toktree

    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

    Information Extracted from Docstrings

Inherited from APIDoc: descr, extra_docstring_fields, metadata, other_docs, summary

    Source Information

Inherited from APIDoc: docs_extracted_by

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

is_detailed(self)

source code 
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)