summaryrefslogtreecommitdiffstats
path: root/doc/CrtMathFnc.3
diff options
context:
space:
mode:
authordonal.k.fellows@manchester.ac.uk <dkf>2012-11-20 12:13:43 (GMT)
committerdonal.k.fellows@manchester.ac.uk <dkf>2012-11-20 12:13:43 (GMT)
commit3e55ef9d38f9ad0ce68ab947b51a37b144046100 (patch)
treefb090e3289193ec27321e51dab2e78b60ac9de05 /doc/CrtMathFnc.3
parentabcad102a592db423039b297a5885beb9034ad5b (diff)
parent884171d33416e69905bbb16e8734dd1d760ed08a (diff)
downloadtcl-3e55ef9d38f9ad0ce68ab947b51a37b144046100.zip
tcl-3e55ef9d38f9ad0ce68ab947b51a37b144046100.tar.gz
tcl-3e55ef9d38f9ad0ce68ab947b51a37b144046100.tar.bz2
merge dkf-compile-misc-info
Diffstat (limited to 'doc/CrtMathFnc.3')
-rw-r--r--doc/CrtMathFnc.311
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/CrtMathFnc.3 b/doc/CrtMathFnc.3
index 3f2c84e..cdde20b 100644
--- a/doc/CrtMathFnc.3
+++ b/doc/CrtMathFnc.3
@@ -10,6 +10,13 @@
.BS
.SH NAME
Tcl_CreateMathFunc, Tcl_GetMathFuncInfo, Tcl_ListMathFuncs \- Define, query and enumerate math functions for expressions
+.SH "NOTICE OF EVENTUAL DEPRECATION"
+.PP
+The \fBTcl_CreateMathFunc\fR and \fBTcl_GetMathFuncInfo\fR functions
+are rendered somewhat obsolete by the ability to create functions for
+expressions by placing commands in the \fBtcl::mathfunc\fR namespace,
+as described in the \fBmathfunc\fR manual page; the API described on
+this page is not expected to be maintained indefinitely.
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
@@ -146,9 +153,9 @@ will not be modified. The variable pointed to by \fInumArgsPointer\fR
will contain -1, and no argument types will be stored in the variable
pointed to by \fIargTypesPointer\fR.
.PP
-\fBTcl_ListMathFuncs\fR returns a Tcl object containing a list of all
+\fBTcl_ListMathFuncs\fR returns a Tcl value containing a list of all
the math functions defined in the interpreter whose name matches
-\fIpattern\fR. The returned object has a reference count of zero.
+\fIpattern\fR. The returned value has a reference count of zero.
.SH "SEE ALSO"
expr(n), info(n), Tcl_CreateObjCommand(3), Tcl_Free(3), Tcl_NewListObj(3)
.SH KEYWORDS