Class documentation: System.doc

The Kite documentation system.

Inherits

System.object

Classes contained

• System.doc.class_node: Documentation node corresponding to a class.
• System.doc.constructor_node: Document node corresponding to a constructor.
• System.doc.destructor_node: Document node corresponding to a destructor.
• System.doc.doc_node: Common interface for documentation nodes.
• System.doc.method_argument_node: Document node corresponding to a method argument.
• System.doc.method_node: Document node corresponding to a method.
• System.doc.operator_node: Document node corresponding to an operator.
• System.doc.outputters: Output methods for the Kite documentation system.
• System.doc.property_node: Document node corresponding to a property.

Constructors

Destructor

Operators

Properties

Methods

• generate_constructor(class_name, method_obj): Generate documentation for a constructor.
  • class_name: Name of class.
  • method_obj: System.method object corresponding to constructor.
• generate_destructor(class_name, method_obj): Generate documentation for a destructor.
  • class_name: Name of class.
  • method_obj: System.method object corresponding to destructor.
• generate_doc(cls): Generate documentation objects for the given class.
  • cls: Class object to generate documentation for.
• generate_doc_helper(cls, done_list): Helper method for generating documentation (not intended for public use)
  • cls: Class object to generate documentation for.
  • done_list: System.collections.binary_tree object with list of generated classes.
• generate_method(method_name, method_obj): Generate documentation for a method.
  • method_name: Name of method.
  • method_obj: System.method object corresponding to a method.
• generate_method_arguments(method_doc, method_obj): Generate documentation for method arguments.
  • method_doc: System.doc.method_node object.
  • method_obj: System.method object corresponding to the method to generate arguments for.
• generate_operator(op_name, op_method): Generate documentation for an operator.
  • op_name: Name of operator.
  • op_method: System.method object corresponding to operator.
• generate_property(cls, name): Generate documentation for a property.
  • cls: Class object property belongs to.
  • name: Property name.