Changes To Documentation

Changes to "Documentation" between 2014-06-23 00:32:12 and 2014-06-23 01:31:57

    33     33   Creates a Tcl procedure that calls C code.
    34     34   
    35     35   Synoposis:
    36     36   
    37     37           $handle cproc <procName> <argList> <returnType> ?<code>?
    38     38   
    39     39     1. `<procName>` is the name of the Tcl procedure to create
    40         -  1. `<argList>` is a list of arguments and their types for the C function;
    41         -    1. The list is in the format of: type1 name1 type2 name2 ... typeN nameN
    42         -    1. The supported types are:
    43         -       1. Tcl_Interp*: Must be first argument, will be the interpreter and the user will not need to pass this parameter
    44         -       1. int
    45         -       1. long
    46         -       1. float
    47         -       1. double
    48         -       1. char*
    49         -       1. Tcl_Obj*: Passes the Tcl object in unchanged
    50         -       1. void*
    51         -  1. `<returnType>` is the return type for the C function
    52         -    1. The supported types are:
    53         -       1. void: No return value
    54         -       1. ok: Return TCL\_OK or TCL_ERROR
    55         -       1. int
    56         -       1. long
    57         -       1. float
    58         -       1. double
    59         -       1. char*: TCL\_STATIC string (immutable from C -- use this for constants)
    60         -       1. string, dstring: return a (char*) that is a TCL\_DYNAMIC string (allocated from Tcl\_Alloc, will be managed by Tcl)
    61         -       1. vstring: return a (char*) that is a TCL\_VOLATILE string (mutable from C, will be copied be Tcl -- use this for local variables)
    62         -       1. default: Tcl\_Obj*, a Tcl Object
    63         -  1. `<code>` is the C code that comprises the function.  If the `<code>` argument is omitted it is assumed there is already an implementation (with the name specified as `<procName>`, minus any namespace declarations) and this just creates the wrapper and Tcl command.
           40  +  2. `<argList>` is a list of arguments and their types for the C function;
           41  +    2. The list is in the format of: type1 name1 type2 name2 ... typeN nameN
           42  +    2. The supported types are:
           43  +       2. Tcl_Interp*: Must be first argument, will be the interpreter and the user will not need to pass this parameter
           44  +       2. int
           45  +       2. long
           46  +       2. float
           47  +       2. double
           48  +       2. char*
           49  +       2. Tcl_Obj*: Passes the Tcl object in unchanged
           50  +       2. Tcl_WideInt
           51  +       2. void*
           52  +  3. `<returnType>` is the return type for the C function
           53  +    3. The supported types are:
           54  +       3. void: No return value
           55  +       3. ok: Return TCL\_OK or TCL_ERROR
           56  +       3. int
           57  +       3. long
           58  +       3. float
           59  +       3. double
           60  +       3. Tcl_WideInt
           61  +       3. char*: TCL\_STATIC string (immutable from C -- use this for constants)
           62  +       3. string, dstring: return a (char*) that is a TCL\_DYNAMIC string (allocated from Tcl\_Alloc, will be managed by Tcl)
           63  +       3. vstring: return a (char*) that is a TCL\_VOLATILE string (mutable from C, will be copied be Tcl -- use this for local variables)
           64  +       3. default: Tcl\_Obj*, a Tcl Object
           65  +  4. `<code>` is the C code that comprises the function.  If the `<code>` argument is omitted it is assumed there is already an implementation (with the name specified as `<procName>`, minus any namespace declarations) and this just creates the wrapper and Tcl command.
    64     66   
    65     67   $handle ccode
    66     68   -------------
    67     69   Compile arbitrary C code.
    68     70   
    69     71   Synopsis:
    70     72