Class ClassDoc

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)

Call Graph

Return a specified subset of this class's sorted_variables list. If value_type is given, then only return variables whose values have the specified type. If group is given, then only return variables that belong to the specified group. If inherited is True, then only return inherited variables; if inherited is False, then only return local variables.

Parameters:

• value_type (string) - A string specifying the value type for which variables should be returned. Valid values are:
  • 'instancemethod' - variables whose values are instance methods.
  • 'classmethod' - variables whose values are class methods.
  • 'staticmethod' - variables whose values are static methods.
  • 'properties' - variables whose values are properties.
  • 'class' - variables whose values are nested classes (including exceptions and types).
  • 'instancevariable' - instance variables. This includes any variables that are explicitly marked as instance variables with docstring fields; and variables with docstrings that are initialized in the constructor.
  • 'classvariable' - class variables. This includes any variables that are not included in any of the above categories.
• group (string) - The name of the group for which variables should be returned. A complete list of the groups defined by this ClassDoc is available in the group_names instance variable. The first element of this list is always the special group name '', which is used for variables that do not belong to any group.
• inherited - If None, then return both inherited and local variables; if True, then return only inherited variables; if False, then return only local variables.
• detailed (bool) - If True (False), return only the variables deserving (not deserving) a detailed informative box. If None, don't care.