summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2022-09-14 07:19:10 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2022-09-14 07:19:10 (GMT)
commita267b4feeba6903ec6b84d760f0dfa05812b79fe (patch)
treed212617fbd54bfc08f78cd4132067edb1507f8c5 /doc
parentfd14473a4c83f51302ba81076ec2f9d3ce9be74b (diff)
downloadtcl-a267b4feeba6903ec6b84d760f0dfa05812b79fe.zip
tcl-a267b4feeba6903ec6b84d760f0dfa05812b79fe.tar.gz
tcl-a267b4feeba6903ec6b84d760f0dfa05812b79fe.tar.bz2
More logical-or markup fixes in documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/ByteArrObj.32
-rw-r--r--doc/DictObj.32
-rw-r--r--doc/FileSystem.32
-rw-r--r--doc/ParseArgs.32
-rw-r--r--doc/SplitList.32
-rw-r--r--doc/SplitPath.32
-rw-r--r--doc/StringObj.32
7 files changed, 7 insertions, 7 deletions
diff --git a/doc/ByteArrObj.3 b/doc/ByteArrObj.3
index ad1eb32..69f55d6 100644
--- a/doc/ByteArrObj.3
+++ b/doc/ByteArrObj.3
@@ -43,7 +43,7 @@ overwritten by a byte-array value. For \fBTcl_GetBytesFromObj\fR,
to the value from which to extract an array of bytes.
.AP Tcl_Interp *interp in
Interpreter to use for error reporting.
-.AP "size_t | int" *numBytesPtr out
+.AP "size_t \&| int" *numBytesPtr out
Points to space where the number of bytes in the array may be written.
Caller may pass NULL when it does not need this information.
.BE
diff --git a/doc/DictObj.3 b/doc/DictObj.3
index c03d267..ebff7bf 100644
--- a/doc/DictObj.3
+++ b/doc/DictObj.3
@@ -70,7 +70,7 @@ Points to a variable that will have the value from a key/value pair
placed within it. For \fBTcl_DictObjFirst\fR and
\fBTcl_DictObjNext\fR, this may be NULL to indicate that the caller is
not interested in the value.
-.AP size_t | int *sizePtr out
+.AP "size_t \&| int" *sizePtr out
Points to a variable that will have the number of key/value pairs
contained within the dictionary placed within it.
.AP Tcl_DictSearch *searchPtr in/out
diff --git a/doc/FileSystem.3 b/doc/FileSystem.3
index 0975dbe..ae4f4b3 100644
--- a/doc/FileSystem.3
+++ b/doc/FileSystem.3
@@ -269,7 +269,7 @@ allowed for the \fImode\fR argument to the Tcl \fBopen\fR command.
.AP int permissions in
POSIX-style permission flags such as 0644. If a new file is created, these
permissions will be set on the created file.
-.AP size_t | int *lenPtr out
+.AP "size_t \&| int" *lenPtr out
If non-NULL, filled with the number of elements in the split path.
.AP Tcl_Obj *basePtr in
The base path on to which to join the given elements. May be NULL.
diff --git a/doc/ParseArgs.3 b/doc/ParseArgs.3
index 02b52d4..6a5184f 100644
--- a/doc/ParseArgs.3
+++ b/doc/ParseArgs.3
@@ -21,7 +21,7 @@ int
Where to store error messages.
.AP "const Tcl_ArgvInfo" *argTable in
Pointer to array of option descriptors.
-.AP size_t | int *objcPtr in/out
+.AP "size_t \&| int" *objcPtr in/out
A pointer to variable holding number of arguments in \fIobjv\fR. Will be
modified to hold number of arguments left in the unprocessed argument list
stored in \fIremObjv\fR.
diff --git a/doc/SplitList.3 b/doc/SplitList.3
index f56330b..6d9a9aa 100644
--- a/doc/SplitList.3
+++ b/doc/SplitList.3
@@ -38,7 +38,7 @@ Interpreter to use for error reporting. If NULL, then no error message
is left.
.AP "const char" *list in
Pointer to a string with proper list structure.
-.AP size_t | int *argcPtr out
+.AP "size_t \&| int" *argcPtr out
Filled in with number of elements in \fIlist\fR.
.AP "const char" ***argvPtr out
\fI*argvPtr\fR will be filled in with the address of an array of
diff --git a/doc/SplitPath.3 b/doc/SplitPath.3
index ff16792..10e84f5 100644
--- a/doc/SplitPath.3
+++ b/doc/SplitPath.3
@@ -25,7 +25,7 @@ Tcl_PathType
.AP "const char" *path in
File path in a form appropriate for the current platform (see the
\fBfilename\fR manual entry for acceptable forms for path names).
-.AP size_t | int *argcPtr out
+.AP "size_t \&| int" *argcPtr out
Filled in with number of path elements in \fIpath\fR.
.AP "const char" ***argvPtr out
\fI*argvPtr\fR will be filled in with the address of an array of
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index 4991f1c..14041c5 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -118,7 +118,7 @@ the last one available.
Points to a value to manipulate.
.AP Tcl_Obj *appendObjPtr in
The value to append to \fIobjPtr\fR in \fBTcl_AppendObjToObj\fR.
-.AP size_t | int *lengthPtr out
+.AP "size_t \&| int" *lengthPtr out
The location where \fBTcl_GetStringFromObj\fR will store the length
of a value's string representation. May be (int *)NULL when not used.
.AP "const char" *string in