* doc/IntObj.3: Update docs for the Tcl_GetBignumAndClearObj() ->

        Tcl_TakeBignumFromObj() revision [TIP 298].  Added docs for the
        Tcl_InitBignumFromDouble() routine. [Bug 1446971].

1 files changed, 14 insertions, 2 deletions

diff --git a/doc/IntObj.3 b/doc/IntObj.3
index f91fb1e..37d6ff2 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.12 2007/12/12 16:34:47 dgp Exp $
+'\" RCS: @(#) $Id: IntObj.3,v 1.13 2007/12/12 16:53:42 dgp Exp $
 '\" 
 .so man.macros
 .TH Tcl_IntObj 3 8.5 Tcl "Tcl Library Procedures"
@@ -53,9 +53,12 @@ int
 .sp
 int
 \fBTcl_TakeBignumFromObj\fR(\fIinterp, objPtr, bigValue\fR)
+.sp
+int
+\fBTcl_InitBignumFromDouble\fR(\fIinterp, doubleValue, bigValue\fR)
 .VE 8.5
 .SH ARGUMENTS
-.AS Tcl_WideInt longValue in/out
+.AS Tcl_WideInt doubleValue in/out
 .AP int intValue in
 Integer value used to initialize or set a Tcl object.
 .AP long longValue in
@@ -83,6 +86,11 @@ Points to place to store the wide integer value retrieved from \fIobjPtr\fR.
 Points to a multi-precision integer structure declared by the LibTomMath
 library.
 .VE 8.5
+.AP double doubleValue in
+.VS 8.5
+Double value from which the integer part is determined and
+used to initialize a multi-precision integer value.
+.VE 8.5
 .BE
 
 .SH DESCRIPTION
@@ -143,6 +151,10 @@ value to be moved instead of copied, which should be more efficient.
 If anything later in the caller requires
 \fIobjPtr\fR to continue to hold the same value, then
 \fBTcl_GetBignumFromObj\fR must be chosen.
+.PP
+The \fBTcl_InitBignumFromDouble\fR routine is a utility procedure
+that extracts the integer part of \fIdoubleValue\fR and stores that
+integer value in the \fBmp_int\fR value \fIbigValue\fR.
 .VE 8.5
 .SH "SEE ALSO"
 Tcl_NewObj, Tcl_DecrRefCount, Tcl_IncrRefCount, Tcl_GetObjResult