diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2004-10-07 15:15:18 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2004-10-07 15:15:18 (GMT) |
commit | b28ec5359a9e725985e869eb7c60b4d68637aa42 (patch) | |
tree | 40c7dac00a9e649ae1eba8fb339d581f28845b74 /doc/UpVar.3 | |
parent | 4d7bec4bb09136c9340a8506acb17ce671efbd20 (diff) | |
download | tcl-b28ec5359a9e725985e869eb7c60b4d68637aa42.zip tcl-b28ec5359a9e725985e869eb7c60b4d68637aa42.tar.gz tcl-b28ec5359a9e725985e869eb7c60b4d68637aa42.tar.bz2 |
Convert CONST to const, VOID to void so we document how we want the API used.
Diffstat (limited to 'doc/UpVar.3')
-rw-r--r-- | doc/UpVar.3 | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/UpVar.3 b/doc/UpVar.3 index 0c8beeb..56aba45 100644 --- a/doc/UpVar.3 +++ b/doc/UpVar.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: UpVar.3,v 1.9 2004/10/07 14:44:35 dkf Exp $ +'\" RCS: @(#) $Id: UpVar.3,v 1.10 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_UpVar 3 7.4 Tcl "Tcl Library Procedures" @@ -22,18 +22,18 @@ int int \fBTcl_UpVar2(\fIinterp, frameName, name1, name2, destName, flags\fB)\fR .SH ARGUMENTS -.AS "CONST char" *sourceName +.AS "const char" *sourceName .AP Tcl_Interp *interp in Interpreter containing variables; also used for error reporting. -.AP "CONST char" *frameName in +.AP "const char" *frameName in Identifies the stack frame containing source variable. May have any of the forms accepted by the \fBupvar\fR command, such as \fB#0\fR or \fB1\fR. -.AP "CONST char" *sourceName in +.AP "const char" *sourceName in Name of source variable, in the frame given by \fIframeName\fR. May refer to a scalar variable or to an array variable with a parenthesized index. -.AP "CONST char" *destName in +.AP "const char" *destName in Name of destination variable, which is to be linked to source variable so that references to \fIdestName\fR refer to the other variable. Must not currently exist except as @@ -42,10 +42,10 @@ an upvar-ed variable. Either \fBTCL_GLOBAL_ONLY\fR or 0; if non-zero, then \fIdestName\fR is a global variable; otherwise it is a local to the current procedure (or global if no procedure is active). -.AP "CONST char" *name1 in +.AP "const char" *name1 in First part of source variable's name (scalar name, or name of array without array index). -.AP "CONST char" *name2 in +.AP "const char" *name2 in If source variable is an element of an array, gives the index of the element. For scalar source variables, is NULL. .BE |