More small bits of doc polishing

tcltk · Jan 21, 2024 · 8dcb1ee · 8dcb1ee
1 parent 514500f
commit 8dcb1ee
Show file tree

Hide file tree

Showing 146 changed files with 261 additions and 350 deletions.
diff --git a/doc/Access.3 b/doc/Access.3
@@ -18,6 +18,7 @@ int
 .sp
 int
 \fBTcl_Stat\fR(\fIpath\fR, \fIstatPtr\fR)
+.fi
 .SH ARGUMENTS
 .AS "struct stat" *statPtr out
 .AP "const char" *path in

diff --git a/doc/AddErrInfo.3 b/doc/AddErrInfo.3
@@ -13,7 +13,7 @@ Tcl_GetReturnOptions, Tcl_SetReturnOptions, Tcl_AddErrorInfo, Tcl_AppendObjToErr
 .SH SYNOPSIS
 .nf
 \fB#include <tcl.h>\fR
-.sp
+
 Tcl_Obj *
 \fBTcl_GetReturnOptions\fR(\fIinterp, code\fR)
 .sp
@@ -28,17 +28,18 @@ int
 .sp
 \fBTcl_SetObjErrorCode\fR(\fIinterp, errorObjPtr\fR)
 .sp
-\fBTcl_SetErrorCode\fR(\fIinterp, element, element, ... \fB(char *)NULL\fR)
+\fBTcl_SetErrorCode\fR(\fIinterp, element, element, ... \fBNULL\fR)
 .sp
+int
 \fBTcl_GetErrorLine\fR(\fIinterp\fR)
 .sp
 \fBTcl_SetErrorLine\fR(\fIinterp, lineNum\fR)
 .sp
 const char *
 \fBTcl_PosixError\fR(\fIinterp\fR)
 .sp
-void
 \fBTcl_LogCommandInfo\fR(\fIinterp, script, command, commandLength\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_Interp commandLength
 .AP Tcl_Interp *interp in

diff --git a/doc/Alloc.3 b/doc/Alloc.3
@@ -16,7 +16,6 @@ Tcl_Alloc, Tcl_Free, Tcl_Realloc, Tcl_AttemptAlloc, Tcl_AttemptRealloc, Tcl_GetM
 char *
 \fBTcl_Alloc\fR(\fIsize\fR)
 .sp
-void
 \fBTcl_Free\fR(\fIptr\fR)
 .sp
 void *
@@ -28,8 +27,8 @@ void *
 void *
 \fBTcl_AttemptRealloc\fR(\fIptr, size\fR)
 .sp
-void
 \fBTcl_GetMemoryInfo\fR(\fIdsPtr\fR)
+.fi
 .SH ARGUMENTS
 .AS char *size
 .AP "size_t" size in

diff --git a/doc/AllowExc.3 b/doc/AllowExc.3
@@ -15,6 +15,7 @@ Tcl_AllowExceptions \- allow all exceptions in next script evaluation
 \fB#include <tcl.h>\fR
 .sp
 \fBTcl_AllowExceptions\fR(\fIinterp\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_Interp *interp
 .AP Tcl_Interp *interp in

diff --git a/doc/AppInit.3 b/doc/AppInit.3
@@ -16,6 +16,7 @@ Tcl_AppInit \- perform application-specific initialization
 .sp
 int
 \fBTcl_AppInit\fR(\fIinterp\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_Interp *interp
 .AP Tcl_Interp *interp in

diff --git a/doc/AssocData.3 b/doc/AssocData.3
@@ -19,6 +19,7 @@ void *
 \fBTcl_SetAssocData\fR(\fIinterp, key, delProc, clientData\fR)
 .sp
 \fBTcl_DeleteAssocData\fR(\fIinterp, key\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_InterpDeleteProc **delProcPtr
 .AP Tcl_Interp *interp in

diff --git a/doc/Async.3 b/doc/Async.3
@@ -17,7 +17,6 @@ Tcl_AsyncCreate, Tcl_AsyncMark, Tcl_AsyncMarkFromSignal, Tcl_AsyncInvoke, Tcl_As
 Tcl_AsyncHandler
 \fBTcl_AsyncCreate\fR(\fIproc, clientData\fR)
 .sp
-void
 \fBTcl_AsyncMark\fR(\fIasync\fR)
 .sp
 int
@@ -26,11 +25,11 @@ int
 int
 \fBTcl_AsyncInvoke\fR(\fIinterp, code\fR)
 .sp
-void
 \fBTcl_AsyncDelete\fR(\fIasync\fR)
 .sp
 int
 \fBTcl_AsyncReady\fR()
+.fi
 .SH ARGUMENTS
 .AS Tcl_AsyncHandler clientData
 .AP Tcl_AsyncProc *proc in

diff --git a/doc/BackgdErr.3 b/doc/BackgdErr.3
@@ -17,6 +17,7 @@ Tcl_BackgroundException, Tcl_BackgroundError \- report Tcl exception that occurr
 \fBTcl_BackgroundException\fR(\fIinterp, code\fR)
 .sp
 \fBTcl_BackgroundError\fR(\fIinterp\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_Interp *interp
 .AP Tcl_Interp *interp in

diff --git a/doc/BoolObj.3 b/doc/BoolObj.3
@@ -24,6 +24,7 @@ int
 .sp
 int
 \fBTcl_GetBoolFromObj\fR(\fIinterp, objPtr, flags. charPtr\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_Interp intValue in/out
 .AP int intValue in

diff --git a/doc/ByteArrObj.3 b/doc/ByteArrObj.3
@@ -16,7 +16,6 @@ Tcl_NewByteArrayObj, Tcl_SetByteArrayObj, Tcl_GetBytesFromObj, Tcl_GetByteArrayF
 Tcl_Obj *
 \fBTcl_NewByteArrayObj\fR(\fIbytes, numBytes\fR)
 .sp
-void
 \fBTcl_SetByteArrayObj\fR(\fIobjPtr, bytes, numBytes\fR)
 .sp
 .VS TIP568
@@ -29,6 +28,7 @@ unsigned char *
 .sp
 unsigned char *
 \fBTcl_SetByteArrayLength\fR(\fIobjPtr, numBytes\fR)
+.fi
 .SH ARGUMENTS
 .AS "const unsigned char" *numBytesPtr in/out
 .AP "const unsigned char" *bytes in

diff --git a/doc/CallDel.3 b/doc/CallDel.3
@@ -17,6 +17,7 @@ Tcl_CallWhenDeleted, Tcl_DontCallWhenDeleted \- Arrange for callback when interp
 \fBTcl_CallWhenDeleted\fR(\fIinterp\fR, \fIproc\fR, \fIclientData\fR)
 .sp
 \fBTcl_DontCallWhenDeleted\fR(\fIinterp\fR, \fIproc\fR, \fIclientData\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_InterpDeleteProc clientData
 .AP Tcl_Interp *interp in

diff --git a/doc/Cancel.3 b/doc/Cancel.3
@@ -17,6 +17,7 @@ int
 .sp
 int
 \fBTcl_Canceled\fR(\fIinterp, flags\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_Interp *interp
 .AP Tcl_Interp *interp in

diff --git a/doc/ChnlStack.3 b/doc/ChnlStack.3
@@ -11,7 +11,6 @@
 Tcl_StackChannel, Tcl_UnstackChannel, Tcl_GetStackedChannel, Tcl_GetTopChannel \- manipulate stacked I/O channels
 .SH SYNOPSIS
 .nf
-.nf
 \fB#include <tcl.h>\fR
 .sp
 Tcl_Channel
@@ -25,7 +24,7 @@ Tcl_Channel
 .sp
 Tcl_Channel
 \fBTcl_GetTopChannel\fR(\fIchannel\fR)
-.sp
+.fi
 .SH ARGUMENTS
 .AS Tcl_ChannelType clientData
 .AP Tcl_Interp *interp in

diff --git a/doc/Class.3 b/doc/Class.3
@@ -63,6 +63,7 @@ Tcl_Class
 Tcl_Obj *
 \fBTcl_GetObjectClassName\fR(\fIinterp\fR, \fIobject\fR)
 .VE "TIP 605"
+.fi
 .SH ARGUMENTS
 .AS void *metadata in/out
 .AP Tcl_Interp *interp in/out

diff --git a/doc/CmdCmplt.3 b/doc/CmdCmplt.3
@@ -16,6 +16,7 @@ Tcl_CommandComplete \- Check for unmatched braces in a Tcl command
 .sp
 int
 \fBTcl_CommandComplete\fR(\fIcmd\fR)
+.fi
 .SH ARGUMENTS
 .AS "const char" *cmd
 .AP "const char" *cmd in

diff --git a/doc/Concat.3 b/doc/Concat.3
@@ -16,6 +16,7 @@ Tcl_Concat \- concatenate a collection of strings
 .sp
 const char *
 \fBTcl_Concat\fR(\fIargc, argv\fR)
+.fi
 .SH ARGUMENTS
 .AS "const char *const" argv[]
 .AP Tcl_Size argc in

diff --git a/doc/CrtAlias.3 b/doc/CrtAlias.3
@@ -49,6 +49,7 @@ int
 .sp
 int
 \fBTcl_HideCommand\fR(\fIinterp, cmdName, hiddenCmdName\fR)
+.fi
 .SH ARGUMENTS
 .AS "const char *const" **targetInterpPtr out
 .AP Tcl_Interp *interp in

diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3
@@ -59,13 +59,10 @@ int
 int
 \fBTcl_IsChannelExisting\fR(\fIchannelName\fR)
 .sp
-void
 \fBTcl_CutChannel\fR(\fIchannel\fR)
 .sp
-void
 \fBTcl_SpliceChannel\fR(\fIchannel\fR)
 .sp
-void
 \fBTcl_ClearChannelHandlers\fR(\fIchannel\fR)
 .sp
 int
@@ -115,7 +112,7 @@ Tcl_DriverFlushProc *
 .sp
 Tcl_DriverHandlerProc *
 \fBTcl_ChannelHandlerProc\fR(\fItypePtr\fR)
-.sp
+.fi
 .SH ARGUMENTS
 .AS "const Tcl_ChannelType" *channelName
 .AP "const Tcl_ChannelType" *typePtr in

diff --git a/doc/CrtChnlHdlr.3 b/doc/CrtChnlHdlr.3
@@ -12,15 +12,12 @@
 Tcl_CreateChannelHandler, Tcl_DeleteChannelHandler \- call a procedure when a channel becomes readable or writable
 .SH SYNOPSIS
 .nf
-.nf
 \fB#include <tcl.h>\fR
 .sp
-void
 \fBTcl_CreateChannelHandler\fR(\fIchannel, mask, proc, clientData\fR)
 .sp
-void
 \fBTcl_DeleteChannelHandler\fR(\fIchannel, proc, clientData\fR)
-.sp
+.fi
 .SH ARGUMENTS
 .AS Tcl_ChannelProc clientData
 .AP Tcl_Channel channel in

diff --git a/doc/CrtCloseHdlr.3 b/doc/CrtCloseHdlr.3
@@ -14,12 +14,10 @@ Tcl_CreateCloseHandler, Tcl_DeleteCloseHandler \- arrange for callbacks when cha
 .nf
 \fB#include <tcl.h>\fR
 .sp
-void
 \fBTcl_CreateCloseHandler\fR(\fIchannel, proc, clientData\fR)
 .sp
-void
 \fBTcl_DeleteCloseHandler\fR(\fIchannel, proc, clientData\fR)
-.sp
+.fi
 .SH ARGUMENTS
 .AS Tcl_CloseProc clientData
 .AP Tcl_Channel channel in

diff --git a/doc/CrtCommand.3 b/doc/CrtCommand.3
@@ -16,6 +16,7 @@ Tcl_CreateCommand \- implement new commands in C
 .sp
 Tcl_Command
 \fBTcl_CreateCommand\fR(\fIinterp, cmdName, proc, clientData, deleteProc\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_CmdDeleteProc *deleteProc
 .AP Tcl_Interp *interp in

diff --git a/doc/CrtFileHdlr.3 b/doc/CrtFileHdlr.3
@@ -17,6 +17,7 @@ Tcl_CreateFileHandler, Tcl_DeleteFileHandler \- associate procedure callbacks wi
 \fBTcl_CreateFileHandler\fR(\fIfd, mask, proc, clientData\fR)
 .sp
 \fBTcl_DeleteFileHandler\fR(\fIfd\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_FileProc clientData
 .AP int fd in

diff --git a/doc/CrtInterp.3 b/doc/CrtInterp.3
@@ -24,6 +24,7 @@ int
 .sp
 int
 \fBTcl_InterpActive\fR(\fIinterp\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_Interp *interp
 .AP Tcl_Interp *interp in

diff --git a/doc/CrtObjCmd.3 b/doc/CrtObjCmd.3
@@ -40,12 +40,11 @@ int
 const char *
 \fBTcl_GetCommandName\fR(\fIinterp, token\fR)
 .sp
-void
 \fBTcl_GetCommandFullName\fR(\fIinterp, token, objPtr\fR)
 .sp
 Tcl_Command
 \fBTcl_GetCommandFromObj\fR(\fIinterp, objPtr\fR)
-.sp
+.fi
 .SH ARGUMENTS
 .AS Tcl_CmdDeleteProc *deleteProc in/out
 .AP Tcl_Interp *interp in

diff --git a/doc/CrtTimerHdlr.3 b/doc/CrtTimerHdlr.3
@@ -18,6 +18,7 @@ Tcl_TimerToken
 \fBTcl_CreateTimerHandler\fR(\fImilliseconds, proc, clientData\fR)
 .sp
 \fBTcl_DeleteTimerHandler\fR(\fItoken\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_TimerToken milliseconds
 .AP int milliseconds  in

diff --git a/doc/CrtTrace.3 b/doc/CrtTrace.3
@@ -25,6 +25,7 @@ Tcl_Trace
 \fBTcl_CreateObjTrace2\fR(\fIinterp, level, flags, objProc2, clientData, deleteProc\fR)
 .sp
 \fBTcl_DeleteTrace\fR(\fIinterp, trace\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_CmdObjTraceDeleteProc *deleteProc
 .AP Tcl_Interp *interp in

diff --git a/doc/DString.3 b/doc/DString.3
@@ -42,6 +42,7 @@ char *
 .sp
 Tcl_Obj *
 \fBTcl_DStringToObj\fR(\fIdsPtr\fR)
+.fi
 .sp
 .SH ARGUMENTS
 .AS Tcl_DString newLength in/out

diff --git a/doc/DetachPids.3 b/doc/DetachPids.3
@@ -20,6 +20,7 @@ Tcl_DetachPids, Tcl_ReapDetachedProcs, Tcl_WaitPid \- manage child processes in
 .sp
 Tcl_Pid
 \fBTcl_WaitPid\fR(\fIpid, statusPtr, options\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_Pid *statusPtr out
 .AP Tcl_Size numPids in

diff --git a/doc/DictObj.3 b/doc/DictObj.3
@@ -33,17 +33,16 @@ int
 \fBTcl_DictObjFirst\fR(\fIinterp, dictPtr, searchPtr,
                  keyPtrPtr, valuePtrPtr, donePtr\fR)
 .sp
-void
 \fBTcl_DictObjNext\fR(\fIsearchPtr, keyPtrPtr, valuePtrPtr, donePtr\fR)
 .sp
-void
 \fBTcl_DictObjDone\fR(\fIsearchPtr\fR)
 .sp
 int
 \fBTcl_DictObjPutKeyList\fR(\fIinterp, dictPtr, keyc, keyv, valuePtr\fR)
 .sp
 int
 \fBTcl_DictObjRemoveKeyList\fR(\fIinterp, dictPtr, keyc, keyv\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_DictSearch "**valuePtrPtr" in/out
 .AP Tcl_Interp *interp in

diff --git a/doc/DoOneEvent.3 b/doc/DoOneEvent.3
@@ -16,6 +16,7 @@ Tcl_DoOneEvent \- wait for events and invoke event handlers
 .sp
 int
 \fBTcl_DoOneEvent\fR(\fIflags\fR)
+.fi
 .SH ARGUMENTS
 .AS int flags
 .AP int flags in

diff --git a/doc/DoWhenIdle.3 b/doc/DoWhenIdle.3
@@ -17,6 +17,7 @@ Tcl_DoWhenIdle, Tcl_CancelIdleCall \- invoke a procedure when there are no pendi
 \fBTcl_DoWhenIdle\fR(\fIproc, clientData\fR)
 .sp
 \fBTcl_CancelIdleCall\fR(\fIproc, clientData\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_IdleProc clientData
 .AP Tcl_IdleProc *proc in

diff --git a/doc/DoubleObj.3 b/doc/DoubleObj.3
@@ -20,6 +20,7 @@ Tcl_Obj *
 .sp
 int
 \fBTcl_GetDoubleFromObj\fR(\fIinterp, objPtr, doublePtr\fR)
+.fi
 .SH ARGUMENTS
 .AS Tcl_Interp doubleValue in/out
 .AP double doubleValue in

diff --git a/doc/DumpActiveMemory.3 b/doc/DumpActiveMemory.3
@@ -15,12 +15,10 @@ Tcl_DumpActiveMemory, Tcl_InitMemory, Tcl_ValidateAllMemory \- Validated memory
 int
 \fBTcl_DumpActiveMemory\fR(\fIfileName\fR)
 .sp
-void
 \fBTcl_InitMemory\fR(\fIinterp\fR)
 .sp
-void
 \fBTcl_ValidateAllMemory\fR(\fIfileName, line\fR)
-
+.fi
 .SH ARGUMENTS
 .AS Tcl_Interp *fileName
 .AP Tcl_Interp *interp in