Minor fixes post-review.

2 files changed, 13 insertions, 5 deletions

diff --git a/ChangeLog b/ChangeLog
index d452adb..9d7c832 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2006-04-18  Donal K. Fellows  <dkf@users.sf.net>
+
+	* doc/IntObj.3: Minor review fixes, including better documentation of
+	the behaviour of Tcl_GetBignumAndClearObj.
+
 2006-04-17  Don Porter  <dgp@users.sourceforge.net>
 
 	* doc/IntObj.3:	Documentation changes to account for TIP 237 changes.
diff --git a/doc/IntObj.3 b/doc/IntObj.3
index f03e355..6e68448 100644
--- a/doc/IntObj.3
+++ b/doc/IntObj.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: IntObj.3,v 1.9 2006/04/17 21:00:47 dgp Exp $
+'\" RCS: @(#) $Id: IntObj.3,v 1.10 2006/04/18 15:13:53 dkf Exp $
 '\" 
 .so man.macros
 .TH Tcl_IntObj 3 8.5 Tcl "Tcl Library Procedures"
@@ -24,7 +24,6 @@ Tcl_Obj *
 Tcl_Obj *
 \fBTcl_NewWideIntObj\fR(\fIwideValue\fR)
 .sp
-.sp
 \fBTcl_SetIntObj\fR(\fIobjPtr, intValue\fR)
 .sp
 \fBTcl_SetLongObj\fR(\fIobjPtr, longValue\fR)
@@ -40,6 +39,7 @@ int
 int
 \fBTcl_GetWideIntFromObj\fR(\fIinterp, objPtr, widePtr\fR)
 .sp
+.sp
 .VS 8.5
 \fB#include <tclTomMath.h>\fR
 .sp
@@ -47,6 +47,7 @@ Tcl_Obj *
 \fBTcl_NewBignumObj\fR(\fIbigValue\fR)
 .sp
 \fBTcl_SetBignumObj\fR(\fIobjPtr, bigValue\fR)
+.sp
 int
 \fBTcl_GetBignumFromObj\fR(\fIinterp, objPtr, bigValue\fR)
 .sp
@@ -86,6 +87,7 @@ Points to a multi-precision integer structure consistent with
 one declared by headers of the libtommath library.
 .VE 8.5
 .BE
+
 .SH DESCRIPTION
 .PP
 .VS 8.5
@@ -129,7 +131,10 @@ value exceeds the range of the target type.  If the attempt fails,
 then \fBTCL_ERROR\fR is returned, and if \fIinterp\fR is non-NULL,
 an error message is left in \fIinterp\fR.  The \fBTcl_ObjType\fR
 of \fIobjPtr\fR may be changed to make subsequent calls to the
-same routine more efficient.
+same routine more efficient. Unlike the other functions,
+\fBTcl_GetBignumAndClearObj\fR may set the content of the Tcl object
+\fIobjPtr\fR to an empty string in the process of retrieving the
+multiple-precision integer library.
 .PP
 The choice between \fBTcl_GetBignumFromObj\fR and
 \fBTcl_GetBignumAndClearObj\fR is governed by how the caller will
@@ -142,9 +147,7 @@ to get the same job done, and should be more efficient.  If
 \fIobjPtr\fR to continue to hold the same value, then
 \fBTcl_GetBignumFromObj\fR must be chosen.
 .VE 8.5
-
 .SH "SEE ALSO"
 Tcl_NewObj, Tcl_DecrRefCount, Tcl_IncrRefCount, Tcl_GetObjResult
-
 .SH KEYWORDS
 integer, integer object, integer type, internal representation, object, object type, string representation