Tcl
Namespaces | Classes | Functions
ns Namespace Reference

Documented namespace ns . More...

Namespaces

namespace  itcl_class
namespace  oo_class

Classes

class  itcl_class
 Documented itcl class itcl_class . More...
class  oo_class
 Documented oo class oo_class . More...

Functions

 ns_proc arg
 Documented proc ns_proc .

Detailed Description

Documented namespace ns .

The code is inserted here:

00001 namespace eval ns {
00002   ## Documented proc \c ns_proc .
00003   # param[in] arg some argument
00004   proc ns_proc {arg} {}
00005   ## Documented var \c ns_var .
00006   # Some documentation.
00007   variable ns_var
00008   ## Documented itcl class \c itcl_class .
00009   itcl::class itcl_class {
00010     ## Create object.
00011     constructor {args} {eval $args}
00012     ## Destroy object.
00013     destructor {exit}
00014     ## Documented itcl method \c itcl_method_x .
00015     # param[in] arg Argument
00016     private method itcl_method_x {arg}{}
00017     ## Documented itcl method \c itcl_method_y .
00018     # param[in] arg Argument
00019     protected method itcl_method_y {arg} {}
00020     ## Documented itcl method \c itcl_method_z .
00021     # param[in] arg Argument
00022     public method itcl_method_z {arg} {}
00023     ## Documented common itcl var \c itcl_Var .
00024     common itcl_Var
00025     ## \protectedsection
00026     
00027     variable itcl_var1;#< Documented itcl var \c itcl_var1 .
00028     variable itcl_var2;#< Documented itcl var \c itcl_var2 .
00029   }
00030   ## Documented oo class \c oo_class .
00031   oo::class create oo_class {
00032     ## Create object.
00033     # Configure with args
00034     constructor {args} {eval $args}
00035     ## Destroy object.
00036     # Exit.
00037     destructor {exit}
00038     ## Documented oo var \c oo_var .
00039     # Defined inside class
00040     variable oo_var
00041     ## \private Documented oo method \c oo_method_x .
00042     # param[in] arg Argument
00043     method oo_method_x {arg} {}
00044     ## \protected Documented oo method \c oo_method_y .
00045     # param[in] arg Argument
00046     method oo_method_y {arg} {}
00047     ## \public Documented oo method \c oo_method_z .
00048     # param[in] arg Argument
00049     method oo_method_z {arg} {}
00050   }
00051 }
00052 

Function Documentation

ns::ns_proc arg

Documented proc ns_proc .

param[in] arg some argument

  proc ns_proc {arg} {}