summaryrefslogtreecommitdiffstats
path: root/doc/Hash.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-10-07 15:15:18 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-10-07 15:15:18 (GMT)
commitb28ec5359a9e725985e869eb7c60b4d68637aa42 (patch)
tree40c7dac00a9e649ae1eba8fb339d581f28845b74 /doc/Hash.3
parent4d7bec4bb09136c9340a8506acb17ce671efbd20 (diff)
downloadtcl-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/Hash.3')
-rw-r--r--doc/Hash.318
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/Hash.3 b/doc/Hash.3
index 43cf767..98cf3b2 100644
--- a/doc/Hash.3
+++ b/doc/Hash.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: Hash.3,v 1.16 2004/10/07 14:44:32 dkf Exp $
+'\" RCS: @(#) $Id: Hash.3,v 1.17 2004/10/07 15:15:38 dkf Exp $
'\"
.so man.macros
.TH Tcl_Hash 3 "" Tcl "Tcl Library Procedures"
@@ -46,7 +46,7 @@ Tcl_HashEntry *
Tcl_HashEntry *
\fBTcl_NextHashEntry\fR(\fIsearchPtr\fR)
.sp
-CONST char *
+const char *
\fBTcl_HashStats\fR(\fItablePtr\fR)
.SH ARGUMENTS
.AS Tcl_HashKeyType *searchPtr out
@@ -60,7 +60,7 @@ Kind of keys to use for new hash table. Must be either
\fBTCL_CUSTOM_PTR_KEYS\fR, or an integer value greater than 1.
.AP Tcl_HashKeyType *typePtr in
Address of structure which defines the behaviour of the hash table.
-.AP "CONST char" *key in
+.AP "const char" *key in
Key to use for probe into table. Exact form depends on
\fIkeyType\fR used to create table.
.AP int *newPtr out
@@ -273,8 +273,8 @@ The \fIhashKeyProc\fR member contains the address of a function
called to calculate a hash value for the key.
.CS
typedef unsigned int (Tcl_HashKeyProc) (
- Tcl_HashTable *\fItablePtr\fR,
- VOID *\fIkeyPtr\fR);
+ Tcl_HashTable *\fItablePtr\fR,
+ void *\fIkeyPtr\fR);
.CE
If this is NULL then \fIkeyPtr\fR is used and
\fBTCL_HASH_KEY_RANDOMIZE_HASH\fR is assumed.
@@ -282,8 +282,9 @@ If this is NULL then \fIkeyPtr\fR is used and
The \fIcompareKeysProc\fR member contains the address of a function
called to compare two keys.
.CS
-typedef int (Tcl_CompareHashKeysProc) (VOID *\fIkeyPtr\fR,
- Tcl_HashEntry *\fIhPtr\fR);
+typedef int (Tcl_CompareHashKeysProc) (
+ void *\fIkeyPtr\fR,
+ Tcl_HashEntry *\fIhPtr\fR);
.CE
If this is NULL then the \fIkeyPtr\fR pointers are compared.
If the keys don't match then the function returns 0, otherwise
@@ -293,7 +294,8 @@ The \fIallocEntryProc\fR member contains the address of a function
called to allocate space for an entry and initialize the key.
.CS
typedef Tcl_HashEntry *(Tcl_AllocHashEntryProc) (
- Tcl_HashTable *\fItablePtr\fR, VOID *\fIkeyPtr\fR);
+ Tcl_HashTable *\fItablePtr\fR,
+ void *\fIkeyPtr\fR);
.CE
If this is NULL then Tcl_Alloc is used to allocate enough space for a
Tcl_HashEntry and the key pointer is assigned to key.oneWordValue.