summaryrefslogtreecommitdiffstats
path: root/doc/Namespace.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-07-01 07:59:20 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-07-01 07:59:20 (GMT)
commit8778b6d91d5ee972338f955ca4c98a2527659083 (patch)
treeca67d330dfae342bf66b5a75b5c8eae1622dd7c9 /doc/Namespace.3
parent46a8a46946dc77acf9bf834b5f647510f5cb2be5 (diff)
downloadtcl-8778b6d91d5ee972338f955ca4c98a2527659083.zip
tcl-8778b6d91d5ee972338f955ca4c98a2527659083.tar.gz
tcl-8778b6d91d5ee972338f955ca4c98a2527659083.tar.bz2
Doc fixes. [Bug 983146]
Diffstat (limited to 'doc/Namespace.3')
-rw-r--r--doc/Namespace.325
1 files changed, 6 insertions, 19 deletions
diff --git a/doc/Namespace.3 b/doc/Namespace.3
index d5442ca..53da4eb 100644
--- a/doc/Namespace.3
+++ b/doc/Namespace.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: Namespace.3,v 1.2 2004/03/09 12:59:04 vincentdarley Exp $
+'\" RCS: @(#) $Id: Namespace.3,v 1.3 2004/07/01 07:59:22 dkf Exp $
'\"
'\" Note that some of these functions do not seem to belong, but they
'\" were all introduced with the same TIP (#139)
@@ -13,7 +13,7 @@
.TH Tcl_Namespace 3 8.5 Tcl "Tcl Library Procedures"
.BS
.SH NAME
-Tcl_AppendExportList, Tcl_CreateNamespace, Tcl_DeleteNamespace, Tcl_Export, Tcl_FindCommand, Tcl_FindNamespace, Tcl_ForgetImport, Tcl_GetCommandFromObj, Tcl_GetCommandFullName, Tcl_GetCurrentNamespace, Tcl_GetGloblaNamespace, Tcl_Import \- manipulate namespaces
+Tcl_AppendExportList, Tcl_CreateNamespace, Tcl_DeleteNamespace, Tcl_Export, Tcl_FindCommand, Tcl_FindNamespace, Tcl_ForgetImport, Tcl_GetCurrentNamespace, Tcl_GetGloblaNamespace, Tcl_Import \- manipulate namespaces
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
@@ -24,7 +24,7 @@ Tcl_Namespace *
\fBTcl_DeleteNamespace\fR(\fInsPtr\fR)
.sp
int
-\fBTcl_AppendExportList\fR(\fIinterp, nsPtr, resultObjPtr\fR)
+\fBTcl_AppendExportList\fR(\fIinterp, nsPtr, objPtr\fR)
.sp
int
\fBTcl_Export\fR(\fIinterp, nsPtr, pattern, resetListFirst\fR)
@@ -46,13 +46,8 @@ Tcl_Namespace *
.sp
Tcl_Command
\fBTcl_FindCommand\fR(\fIinterp, name, contextNsPtr, flags\fR)
-.sp
-Tcl_Command
-\fBTcl_GetCommandFromObj\fR(\fIinterp, objPtr\fR)
-.sp
-\fBTcl_GetCommandFullName\fR(\fIinterp, command, resultObjPtr\fR)
.SH ARGUMENTS
-.AS Tcl_NamespaceDeleteProc *resultObjPtr
+.AS Tcl_NamespaceDeleteProc *allowOverwrite
.AP Tcl_Interp *interp in/out
The interpreter in which the namespace exists and where name lookups
are performed. Also where error result messages are written.
@@ -67,7 +62,7 @@ if no such callback is to be performed.
.AP Tcl_Namespace *nsPtr in
The namespace to be manipulated, or NULL (for other than
\fBTcl_DeleteNamespace\fR) to manipulate the current namespace.
-.AP Tcl_Obj *resultObjPtr out
+.AP Tcl_Obj *objPtr out
A reference to an unshared object to which the function output will be
written.
.AP "CONST char" *pattern in
@@ -92,8 +87,6 @@ global namespace), TCL_NAMESPACE_ONLY (just for \fBTcl_FindCommand\fR;
indicates that the search is always to be conducted relative to the
context namespace), and TCL_LEAVE_ERR_MSG (indicates that an error
message should be left in the interpreter if the search fails.)
-.AP Tcl_Obj *objPtr in
-A reference to an object containing the name of a command to look up.
.BE
.SH DESCRIPTION
@@ -123,7 +116,7 @@ typedef void (Tcl_NamespaceDeleteProc) (ClientData clientData);
.PP
\fBTcl_AppendExportList\fR retrieves the export patterns for a
namespace given namespace and appends them (as list items) to
-\fIresultObjPtr\fR.
+\fIobjPtr\fR.
.PP
\fBTcl_Export\fR sets and appends to the export patterns for a
namespace. Patterns are appended unless the \fIresetListFirst\fR flag
@@ -150,12 +143,6 @@ namespace cannot be found, NULL is returned.
\fBTcl_FindCommand\fR searches for a command named \fIname\fR within
the context of the namespace \fIcontextNsPtr\fR. If the command
cannot be found, NULL is returned.
-.PP
-\fBTcl_GetCommandFromObj\fR gets a command token from \fIobjPtr\fR.
-.PP
-\fBTcl_GetCommandFullName\fR gets the fully qualified name of a
-command given its command token, writing that name into the
-\fIresultObjPtr\fR.
.SH "SEE ALSO"
Tcl_CreateCommand, Tcl_ListObjAppendElements, Tcl_SetVar