class documentation

class ClassDiadefGenerator(DiaDefGenerator): (source)

View In Hierarchy

Generate a class diagram definition including all classes related to a given class.

Method class_diagram Return a class diagram definition for the class and related classes.
Instance Variable classdiagram Undocumented

Inherited from DiaDefGenerator:

Method __init__ Common Diagram Handler initialization.
Method add_class Visit one class and add it to diagram.
Method extract_classes Extract recursively classes related to klass_node.
Method get_ancestors Return ancestor nodes of a class node.
Method get_associated Return associated nodes of a class node.
Method get_title Get title for objects.
Method show_node True if builtins and not show_builtins.
Instance Variable anc_level Undocumented
Instance Variable association_level Undocumented
Instance Variable config Undocumented
Instance Variable linker Undocumented
Instance Variable module_names Undocumented
Method _get_levels Help function for search levels.
Method _set_default_options Set different default options with _default dictionary.
Method _set_option Activate some options if not explicitly deactivated.
def class_diagram(self, project: Project, klass: nodes.ClassDef) -> ClassDiagram: (source)

Return a class diagram definition for the class and related classes.