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/GetIndex.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/GetIndex.3')
-rw-r--r-- | doc/GetIndex.3 | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/GetIndex.3 b/doc/GetIndex.3 index 7c4ea50..f54dd3c 100644 --- a/doc/GetIndex.3 +++ b/doc/GetIndex.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetIndex.3,v 1.14 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: GetIndex.3,v 1.15 2004/10/07 15:15:38 dkf Exp $ '\" .so man.macros .TH Tcl_GetIndexFromObj 3 8.1 Tcl "Tcl Library Procedures" @@ -25,7 +25,7 @@ int msg, flags, indexPtr\fR) .VE .SH ARGUMENTS -.AS "CONST char" *structTablePtr in/out +.AS "const char" *structTablePtr in/out .AP Tcl_Interp *interp in Interpreter to use for error reporting; if NULL, then no message is provided on errors. @@ -33,10 +33,10 @@ provided on errors. The string value of this object is used to search through \fItablePtr\fR. The internal representation is modified to hold the index of the matching table entry. -.AP "CONST char" **tablePtr in +.AP "const char" **tablePtr in An array of null-terminated strings. The end of the array is marked by a NULL string pointer. -.AP "CONST VOID" *structTablePtr in +.AP "const void" *structTablePtr in An array of arbitrary type, typically some \fBstruct\fP type. The first member of the structure must be a null-terminated string. The size of the structure is given by \fIoffset\fP. @@ -45,7 +45,7 @@ The size of the structure is given by \fIoffset\fP. The offset to add to structTablePtr to get to the next entry. The end of the array is marked by a NULL string pointer. .VE -.AP "CONST char" *msg in +.AP "const char" *msg in Null-terminated string describing what is being looked up, such as \fBoption\fR. This string is included in error messages. .AP int flags in |