diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2007-10-28 14:17:38 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2007-10-28 14:17:38 (GMT) |
commit | ccacc920f9cd610a9a9d8e800f623c20bf43a702 (patch) | |
tree | daec40c266097bb1d38f10254010691b0131d4cc /doc/GetInt.3 | |
parent | 8ffb8fa76d0d34283e491044dd28385674ba113e (diff) | |
download | tcl-ccacc920f9cd610a9a9d8e800f623c20bf43a702.zip tcl-ccacc920f9cd610a9a9d8e800f623c20bf43a702.tar.gz tcl-ccacc920f9cd610a9a9d8e800f623c20bf43a702.tar.bz2 |
First stage of doing GOOBE improvements to documentation now that the html generation works
Diffstat (limited to 'doc/GetInt.3')
-rw-r--r-- | doc/GetInt.3 | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/doc/GetInt.3 b/doc/GetInt.3 index b1c658e..d07097b 100644 --- a/doc/GetInt.3 +++ b/doc/GetInt.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetInt.3,v 1.12 2007/10/26 20:11:51 dgp Exp $ +'\" RCS: @(#) $Id: GetInt.3,v 1.13 2007/10/28 14:17:38 dkf Exp $ '\" .so man.macros .TH Tcl_GetInt 3 "" Tcl "Tcl Library Procedures" @@ -47,7 +47,7 @@ integers). Each of the procedures takes a \fIsrc\fR argument, converts it to an internal form of a particular type, and stores the converted value at the location indicated by the procedure's third argument. If all goes well, each of the procedures returns -\fBTCL_OK\fR. If \fIsrc\fR doesn't have the proper syntax for the +\fBTCL_OK\fR. If \fIsrc\fR does not have the proper syntax for the desired type then \fBTCL_ERROR\fR is returned, an error message is left in the interpreter's result, and nothing is stored at *\fIintPtr\fR or *\fIdoublePtr\fR or *\fIboolPtr\fR. @@ -55,20 +55,25 @@ or *\fIdoublePtr\fR or *\fIboolPtr\fR. \fBTcl_GetInt\fR expects \fIsrc\fR to consist of a collection of integer digits, optionally signed and optionally preceded by white space. If the first two characters of \fIsrc\fR -after the optional white space and sign are ``0x'' +after the optional white space and sign are +.QW 0x then \fIsrc\fR is expected to be in hexadecimal form; otherwise, -if the first such character is ``0'' then \fIsrc\fR +if the first such character is +.QW 0 +then \fIsrc\fR is expected to be in octal form; otherwise, \fIsrc\fR is expected to be in decimal form. .PP \fBTcl_GetDouble\fR expects \fIsrc\fR to consist of a floating-point number, which is: white space; a sign; a sequence of digits; a -decimal point; a sequence of digits; the letter ``e''; a -signed decimal exponent ; and more white space. +decimal point; a sequence of digits; the letter +.QW e ; +a signed decimal exponent; and more white space. Any of the fields may be omitted, except that the digits either before or after the decimal point must be present -and if the ``e'' is present then it must be followed by the -exponent number. +and if the +.QW e +is present then it must be followed by the exponent number. .PP \fBTcl_GetBoolean\fR expects \fIsrc\fR to specify a boolean value. If \fIsrc\fR is any of \fB0\fR, \fBfalse\fR, |