doc-procs.tcl

Generic doc procs

Location:
packages/xotcl-core/tcl/doc-procs.tcl
Created:
2015-04-30
Author:
Gustaf Neumann
CVS Identification:
$Id: doc-procs.tcl,v 1.9 2024/10/29 16:40:12 gustafn Exp $

Procedures in this file

Detailed information

xo::dot_append_method (private)

 xo::dot_append_method [ -documented_methods documented_methods ] e \
    methods_ref kind
Switches:
-documented_methods (optional, defaults to "1")
Parameters:
e (required)
methods_ref (required)
kind (required)

Partial Call Graph (max 5 caller/called nodes):
%3 xo::dotclass xo::dotclass (private) xo::dot_append_method xo::dot_append_method xo::dotclass->xo::dot_append_method apidoc::get_object_property apidoc::get_object_property (public) xo::dot_append_method->apidoc::get_object_property

Testcases:
No testcase defined.

xo::dotclass (private)

 xo::dotclass [ -is_focus is_focus ] [ -hide_methods hide_methods ] \
    [ -documented_methods documented_methods ] e
Switches:
-is_focus (optional, defaults to "0")
-hide_methods (optional, defaults to "1")
-documented_methods (optional, defaults to "1")
Parameters:
e (required)

Partial Call Graph (max 5 caller/called nodes):
%3 xo::dotcode xo::dotcode (private) xo::dotclass xo::dotclass xo::dotcode->xo::dotclass export_vars export_vars (public) xo::dotclass->export_vars xo::dot_append_method xo::dot_append_method (private) xo::dotclass->xo::dot_append_method xo::dotquote xo::dotquote xo::dotclass->xo::dotquote

Testcases:
No testcase defined.

xo::dotcode (private)

 xo::dotcode [ -with_children with_children ] \
    [ -with_instance_relations with_instance_relations ] \
    [ -omit_base_classes omit_base_classes ] \
    [ -documented_methods documented_methods ] \
    [ -hide_methods hide_methods ] [ -current_object current_object ] \
    [ -dpi dpi ] things
Switches:
-with_children (optional, defaults to "0")
-with_instance_relations (optional, defaults to "0")
-omit_base_classes (optional, defaults to "1")
-documented_methods (optional, defaults to "1")
-hide_methods (optional, defaults to "1")
-current_object (optional)
-dpi (optional, defaults to "96")
Parameters:
things (required)

Partial Call Graph (max 5 caller/called nodes):
%3 packages/xotcl-core/www/show-class-graph.tcl packages/xotcl-core/ www/show-class-graph.tcl xo::dotcode xo::dotcode packages/xotcl-core/www/show-class-graph.tcl->xo::dotcode packages/xotcl-core/www/show-object.tcl packages/xotcl-core/ www/show-object.tcl packages/xotcl-core/www/show-object.tcl->xo::dotcode apidoc::get_object_property apidoc::get_object_property (public) xo::dotcode->apidoc::get_object_property nsf::is nsf::is xo::dotcode->nsf::is xo::dotclass xo::dotclass (private) xo::dotcode->xo::dotclass xo::dotobject xo::dotobject (private) xo::dotcode->xo::dotobject xo::dotquote xo::dotquote xo::dotcode->xo::dotquote

Testcases:
No testcase defined.

xo::dotobject (private)

 xo::dotobject e
Parameters:
e (required)

Partial Call Graph (max 5 caller/called nodes):
%3 xo::dotcode xo::dotcode (private) xo::dotobject xo::dotobject xo::dotcode->xo::dotobject export_vars export_vars (public) xo::dotobject->export_vars xo::dotquote xo::dotquote xo::dotobject->xo::dotquote

Testcases:
No testcase defined.
[ show source ]