From ad9c975e41ced7cdc2f156f683fa8845fb33735a Mon Sep 17 00:00:00 2001
From: "jan.nijtmans" <nijtmans@users.sourceforge.net>
Date: Fri, 15 Apr 2022 14:46:00 +0000
Subject: Update documentation

---
 doc/BoolObj.3 | 18 +++++++++++++-----
 doc/GetInt.3  | 21 ++++++++++++++++-----
 2 files changed, 29 insertions(+), 10 deletions(-)

diff --git a/doc/BoolObj.3 b/doc/BoolObj.3
index afbd1d1..c5bb05f 100644
--- a/doc/BoolObj.3
+++ b/doc/BoolObj.3
@@ -20,7 +20,7 @@ Tcl_Obj *
 \fBTcl_SetBooleanObj\fR(\fIobjPtr, boolValue\fR)
 .sp
 int
-\fBTcl_GetBooleanFromObj\fR(\fIinterp, objPtr, boolPtr\fR)
+\fBTcl_GetBooleanFromObj\fR(\fIinterp, objPtr, intPtr\fR)
 .sp
 int
 \fBTcl_GetBoolFromObj\fR(\fIinterp, objPtr, flags. boolPtr\fR)
@@ -35,13 +35,16 @@ retrieve a boolean value.
 If a boolean value cannot be retrieved,
 an error message is left in the interpreter's result value
 unless \fIinterp\fR is NULL.
+.AP int *intPtr out
+Points to place where \fBTcl_GetBooleanFromObj\fR
+stores the boolean value (0 or 1) obtained from \fIobjPtr\fR.
 .AP int | short | char *boolPtr out
-Points to place where \fBTcl_GetBooleanFromObj\fR/\fBTcl_GetBoolFromObj\fR
+Points to place where \fBTcl_GetBoolFromObj\fR
 stores the boolean value (0 or 1) obtained from \fIobjPtr\fR.
 .AP int flags in
-Value 0 or TCL_NULL_OK. If TCL_NULL_OK, then the empty
-string or NULL will result in \fBTcl_GetBoolFromObj\fR return
-TCL_OK, the *boolPtr filled with the value -1;
+sizeof(*(boolPtr)), possibly combined with TCL_NULL_OK. If TCL_NULL_OK
+is used, then the empty string or NULL will result in \fBTcl_GetBoolFromObj\fR
+return TCL_OK, the *boolPtr filled with the value -1;
 .BE
 
 .SH DESCRIPTION
@@ -83,6 +86,11 @@ fields of \fI*objPtr\fR so that future calls to
 \fBTcl_GetBooleanFromObj\fR on the same \fIobjPtr\fR can be
 performed more efficiently.
 .PP
+\fBTcl_GetBoolFromObj\fR functions almost the same as
+\fBTcl_GetBooleanFromObj\fR, but it has an additional parameter
+\fBflags\fR, which can be used to specify the size of the \fBboolPtr\fR
+variable, and also whether the empty string or NULL is accepted as valid.
+.PP
 Note that the routines \fBTcl_GetBooleanFromObj\fR and
 \fBTcl_GetBoolean\fR are not functional equivalents.
 The set of values for which \fBTcl_GetBooleanFromObj\fR
diff --git a/doc/GetInt.3 b/doc/GetInt.3
index f9b91a2..edce6c1 100644
--- a/doc/GetInt.3
+++ b/doc/GetInt.3
@@ -21,7 +21,10 @@ int
 \fBTcl_GetDouble\fR(\fIinterp, src, doublePtr\fR)
 .sp
 int
-\fBTcl_GetBoolean\fR(\fIinterp, src, boolPtr\fR)
+\fBTcl_GetBoolean\fR(\fIinterp, src, intPtr\fR)
+.sp
+int
+\fBTcl_GetBool\fR(\fIinterp, src, flags, boolPtr\fR)
 .SH ARGUMENTS
 .AS Tcl_Interp *doublePtr out
 .AP Tcl_Interp *interp in
@@ -34,7 +37,11 @@ Points to place to store integer value converted from \fIsrc\fR.
 Points to place to store double-precision floating-point
 value converted from \fIsrc\fR.
 .AP int | short | char *boolPtr out
-Points to place to store boolean value (0 or 1) converted from \fIsrc\fR.
+Points to place to store boolean value (0 or 1) value converted from \fIsrc\fR.
+.AP int flags in
+sizeof(*(boolPtr)), possibly combined with TCL_NULL_OK. If TCL_NULL_OK
+is used, then the empty string or NULL will result in \fBTcl_GetBool\fR
+return TCL_OK, the *boolPtr filled with the value -1;
 .BE
 
 .SH DESCRIPTION
@@ -94,11 +101,15 @@ inter-digit separator be present.
 \fBTcl_GetBoolean\fR expects \fIsrc\fR to specify a boolean
 value.  If \fIsrc\fR is any of \fB0\fR, \fBfalse\fR,
 \fBno\fR, or \fBoff\fR, then \fBTcl_GetBoolean\fR stores a zero
-value at \fI*boolPtr\fR.
+value at \fI*intPtr\fR.
 If \fIsrc\fR is any of \fB1\fR, \fBtrue\fR, \fByes\fR, or \fBon\fR,
-then 1 is stored at \fI*boolPtr\fR.
+then 1 is stored at \fI*intPtr\fR.
 Any of these values may be abbreviated, and upper-case spellings
 are also acceptable.
-
+.PP
+\fBTcl_GetBool\fR functions almost the same as \fBTcl_GetBoolean\fR,
+but it has an additional parameter \fBflags\fR, which can be used
+to specify the size of the \fBboolPtr\fR variable, and also whether
+the empty string or NULL is accepted as valid.
 .SH KEYWORDS
 boolean, conversion, double, floating-point, integer
-- 
cgit v0.12