Blame examples/tclexample.tcl

Packit 1c1d7e
## \file tclexample.tcl
Packit 1c1d7e
# File documentation.
Packit 1c1d7e
#\verbatim
Packit 1c1d7e
Packit 1c1d7e
# Startup code:\
Packit 1c1d7e
exec tclsh "$0" "$@"
Packit 1c1d7e
#\endverbatim
Packit 1c1d7e
## Documented namespace \c ns .
Packit 1c1d7e
# The code is inserted here:
Packit 1c1d7e
#\code
Packit 1c1d7e
namespace eval ns {
Packit 1c1d7e
  ## Documented proc \c ns_proc .
Packit 1c1d7e
  # param[in] arg some argument
Packit 1c1d7e
  proc ns_proc {arg} {}
Packit 1c1d7e
  ## Documented var \c ns_var .
Packit 1c1d7e
  # Some documentation.
Packit 1c1d7e
  variable ns_var
Packit 1c1d7e
  ## Documented itcl class \c itcl_class .
Packit 1c1d7e
  itcl::class itcl_class {
Packit 1c1d7e
    ## Create object.
Packit 1c1d7e
    constructor {args} {eval $args}
Packit 1c1d7e
    ## Destroy object.
Packit 1c1d7e
    destructor {exit}
Packit 1c1d7e
    ## Documented itcl method \c itcl_method_x .
Packit 1c1d7e
    # param[in] arg Argument
Packit 1c1d7e
    private method itcl_method_x {arg}
Packit 1c1d7e
    ## Documented itcl method \c itcl_method_y .
Packit 1c1d7e
    # param[in] arg Argument
Packit 1c1d7e
    protected method itcl_method_y {arg} {}
Packit 1c1d7e
    ## Documented itcl method \c itcl_method_z .
Packit 1c1d7e
    # param[in] arg Argument
Packit 1c1d7e
    public method itcl_method_z {arg} {}
Packit 1c1d7e
    ## Documented common itcl var \c itcl_Var .
Packit 1c1d7e
    common itcl_Var
Packit 1c1d7e
    ## \protectedsection
Packit 1c1d7e
    
Packit 1c1d7e
    variable itcl_var1;#< Documented itcl var \c itcl_var1 .
Packit 1c1d7e
    variable itcl_var2;#< Documented itcl var \c itcl_var2 .
Packit 1c1d7e
  }
Packit 1c1d7e
  ## Documented oo class \c oo_class .
Packit 1c1d7e
  oo::class create oo_class {
Packit 1c1d7e
    ## Create object.
Packit 1c1d7e
    # Configure with args
Packit 1c1d7e
    constructor {args} {eval $args}
Packit 1c1d7e
    ## Destroy object.
Packit 1c1d7e
    # Exit.
Packit 1c1d7e
    destructor {exit}
Packit 1c1d7e
    ## Documented oo var \c oo_var .
Packit 1c1d7e
    # Defined inside class
Packit 1c1d7e
    variable oo_var
Packit 1c1d7e
    ## \private Documented oo method \c oo_method_x .
Packit 1c1d7e
    # param[in] arg Argument
Packit 1c1d7e
    method oo_method_x {arg} {}
Packit 1c1d7e
    ## \protected Documented oo method \c oo_method_y .
Packit 1c1d7e
    # param[in] arg Argument
Packit 1c1d7e
    method oo_method_y {arg} {}
Packit 1c1d7e
    ## \public Documented oo method \c oo_method_z .
Packit 1c1d7e
    # param[in] arg Argument
Packit 1c1d7e
    method oo_method_z {arg} {}
Packit 1c1d7e
  }
Packit 1c1d7e
}
Packit 1c1d7e
#\endcode
Packit 1c1d7e
Packit 1c1d7e
itcl::body ::ns::itcl_class::itcl_method_x {argx} {
Packit 1c1d7e
  puts "$argx OK"
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
oo::define ns::oo_class {
Packit 1c1d7e
  ## \public Outside defined variable \c oo_var_out .
Packit 1c1d7e
  # Inside oo_class
Packit 1c1d7e
  variable oo_var_out
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
## Documented global proc \c glob_proc .
Packit 1c1d7e
# param[in] arg Argument
Packit 1c1d7e
proc glob_proc {arg} {puts $arg}
Packit 1c1d7e
Packit 1c1d7e
variable glob_var;#< Documented global var \c glob_var\
Packit 1c1d7e
  with newline
Packit 1c1d7e
#< and continued line
Packit 1c1d7e
Packit 1c1d7e
# end of file