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/StringObj.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/StringObj.3')
-rw-r--r-- | doc/StringObj.3 | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/StringObj.3 b/doc/StringObj.3 index 86db898..b7ca7d0 100644 --- a/doc/StringObj.3 +++ b/doc/StringObj.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: StringObj.3,v 1.16 2004/03/23 09:01:00 dkf Exp $ +'\" RCS: @(#) $Id: StringObj.3,v 1.17 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_StringObj 3 8.1 Tcl "Tcl Library Procedures" @@ -72,8 +72,8 @@ int Tcl_Obj * \fBTcl_ConcatObj\fR(\fIobjc, objv\fR) .SH ARGUMENTS -.AS "CONST Tcl_UniChar" *appendObjPtr in/out -.AP "CONST char" *bytes in +.AS "const Tcl_UniChar" *appendObjPtr in/out +.AP "const char" *bytes in .VS 8.1 Points to the first byte of an array of UTF-8-encoded bytes used to set or append to a string object. @@ -87,7 +87,7 @@ the string is a collection of uninterpreted bytes.) The number of bytes to copy from \fIbytes\fR when initializing, setting, or appending to a string object. If negative, all bytes up to the first null are used. -.AP "CONST Tcl_UniChar" *unicode in +.AP "const Tcl_UniChar" *unicode in Points to the first byte of an array of Unicode characters used to set or append to a string object. This byte array may contain embedded null characters @@ -111,7 +111,7 @@ The object to append to \fIobjPtr\fR in \fBTcl_AppendObjToObj\fR. .AP int *lengthPtr out If non-NULL, the location where \fBTcl_GetStringFromObj\fR will store the length of an object's string representation. -.AP "CONST char" *string in +.AP "const char" *string in Null-terminated string value to append to \fIobjPtr\fR. .AP va_list argList in An argument list which must have been initialised using @@ -165,7 +165,7 @@ will be able to modify the string representation within the \fBTcl_UpdateStringProc\fR of their \fBTcl_ObjType\fR. Except for that limited purpose, the pointer returned by \fBTcl_GetStringFromObj\fR or \fBTcl_GetString\fR should be treated as read-only. It is -recommended that this pointer be assigned to a (CONST char *) variable. +recommended that this pointer be assigned to a (const char *) variable. Even in the limited situations where writing to this pointer is acceptable, one should take care to respect the copy-on-write semantics required by \fBTcl_Obj\fR's, with appropriate calls |