summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2024-06-03 11:47:04 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2024-06-03 11:47:04 (GMT)
commit4643a1db2023125602aa96a5d0ea492857ff1722 (patch)
treedd56ea6e1018df82f9d727c7c894cea6d6b83102
parent4a25523bd51f705a6a6aad227de13267caef05dc (diff)
parent272872375d23ecfbbf6d893473176aab97462a44 (diff)
downloadtcl-4643a1db2023125602aa96a5d0ea492857ff1722.zip
tcl-4643a1db2023125602aa96a5d0ea492857ff1722.tar.gz
tcl-4643a1db2023125602aa96a5d0ea492857ff1722.tar.bz2
Use (char *)NULL as end sentinel in documentation (as Linux man-pages already do too, e.g. [https://linux.die.net/man/3/tcl_appendresult])
-rw-r--r--doc/AddErrInfo.34
-rw-r--r--doc/Eval.34
-rw-r--r--doc/SetResult.34
-rw-r--r--doc/StringObj.34
4 files changed, 8 insertions, 8 deletions
diff --git a/doc/AddErrInfo.3 b/doc/AddErrInfo.3
index 05b20b8..2ed5eee 100644
--- a/doc/AddErrInfo.3
+++ b/doc/AddErrInfo.3
@@ -28,7 +28,7 @@ int
.sp
\fBTcl_SetObjErrorCode\fR(\fIinterp, errorObjPtr\fR)
.sp
-\fBTcl_SetErrorCode\fR(\fIinterp, element, element, ... \fBNULL\fR)
+\fBTcl_SetErrorCode\fR(\fIinterp, element, element, ... \fB(char *)NULL\fR)
.sp
int
\fBTcl_GetErrorLine\fR(\fIinterp\fR)
@@ -67,7 +67,7 @@ If negative, all bytes up to the first null byte are used.
The \fB\-errorcode\fR return option will be set to this value.
.AP "const char" *element in
String to record as one element of the \fB\-errorcode\fR return option.
-Last \fIelement\fR argument must be NULL.
+Last \fIelement\fR argument must be (char *)NULL.
.AP int lineNum
The line number of a script where an error occurred.
.AP "const char" *script in
diff --git a/doc/Eval.3 b/doc/Eval.3
index fb0a420..bfef423 100644
--- a/doc/Eval.3
+++ b/doc/Eval.3
@@ -37,7 +37,7 @@ int
\fBTcl_GlobalEvalObj\fR(\fIinterp, objPtr\fR)
.sp
int
-\fBTcl_VarEval\fR(\fIinterp, part, part, ... \fBNULL\fR)
+\fBTcl_VarEval\fR(\fIinterp, part, part, ... \fB(char *)NULL\fR)
.fi
.SH ARGUMENTS
.AS Tcl_Interp **termPtr
@@ -138,7 +138,7 @@ of any length, concatenates them into a single string,
then calls \fBTcl_Eval\fR to execute that string as a Tcl command.
It returns the result of the command and also modifies
the interpreter result in the same way as \fBTcl_Eval\fR.
-The last argument to \fBTcl_VarEval\fR must be NULL to indicate the end
+The last argument to \fBTcl_VarEval\fR must be (char *)NULL to indicate the end
of arguments.
.SH "FLAG BITS"
diff --git a/doc/SetResult.3 b/doc/SetResult.3
index 4d0c9df..954906a 100644
--- a/doc/SetResult.3
+++ b/doc/SetResult.3
@@ -24,7 +24,7 @@ Tcl_Obj *
const char *
\fBTcl_GetStringResult\fR(\fIinterp\fR)
.sp
-\fBTcl_AppendResult\fR(\fIinterp, result, result, ... , \fBNULL\fR)
+\fBTcl_AppendResult\fR(\fIinterp, result, result, ... , \fB(char *)NULL\fR)
.sp
\fBTcl_ResetResult\fR(\fIinterp\fR)
.sp
@@ -93,7 +93,7 @@ storage for the \fIinterp\fR's result, allocating a larger result area if
necessary. It also manages conversion to and from the \fIresult\fR field of
the \fIinterp\fR to handle backward-compatibility with old-style extensions.
Any number of \fIresult\fR arguments may be passed in a single call; the last
-argument in the list must be a NULL pointer.
+argument in the list must be (char *)NULL.
.PP
\fBTcl_TransferResult\fR transfers interpreter state from \fIsourceInterp\fR to
\fItargetInterp\fR, both of which must have been created in the same thread,
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index 6f7d359..e8efc53 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -50,7 +50,7 @@ Tcl_Obj *
.sp
\fBTcl_AppendObjToObj\fR(\fIobjPtr, appendObjPtr\fR)
.sp
-\fBTcl_AppendStringsToObj\fR(\fIobjPtr, string, string, ... \fBNULL\fR)
+\fBTcl_AppendStringsToObj\fR(\fIobjPtr, string, string, ... \fB(char *)NULL\fR)
.sp
\fBTcl_AppendLimitedToObj\fR(\fIobjPtr, bytes, length, limit, ellipsis\fR)
.sp
@@ -242,7 +242,7 @@ except that it can be passed more than one value to append and
each value must be a null-terminated string (i.e. none of the
values may contain internal null characters). Any number of
\fIstring\fR arguments may be provided, but the last argument
-must be a NULL pointer to indicate the end of the list.
+must be (char *)NULL to indicate the end of the list.
.PP
\fBTcl_AppendLimitedToObj\fR is similar to \fBTcl_AppendToObj\fR
except that it imposes a limit on how many bytes are appended.