summaryrefslogtreecommitdiffstats
path: root/doc/Encoding.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-10-07 15:15:18 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-10-07 15:15:18 (GMT)
commitb28ec5359a9e725985e869eb7c60b4d68637aa42 (patch)
tree40c7dac00a9e649ae1eba8fb339d581f28845b74 /doc/Encoding.3
parent4d7bec4bb09136c9340a8506acb17ce671efbd20 (diff)
downloadtcl-b28ec5359a9e725985e869eb7c60b4d68637aa42.zip
tcl-b28ec5359a9e725985e869eb7c60b4d68637aa42.tar.gz
tcl-b28ec5359a9e725985e869eb7c60b4d68637aa42.tar.bz2
Convert CONST to const, VOID to void so we document how we want the API used.
Diffstat (limited to 'doc/Encoding.3')
-rw-r--r--doc/Encoding.318
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/Encoding.3 b/doc/Encoding.3
index 658f081..c365aaf 100644
--- a/doc/Encoding.3
+++ b/doc/Encoding.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: Encoding.3,v 1.19 2004/10/07 14:52:43 dkf Exp $
+'\" RCS: @(#) $Id: Encoding.3,v 1.20 2004/10/07 15:15:37 dkf Exp $
'\"
.so man.macros
.TH Tcl_GetEncoding 3 "8.1" Tcl "Tcl Library Procedures"
@@ -41,7 +41,7 @@ char *
TCHAR *
\fBTcl_WinUtfToTChar\fR(\fIsrc, srcLen, dstPtr\fR)
.sp
-CONST char *
+const char *
\fBTcl_GetEncodingName\fR(\fIencoding\fR)
.sp
int
@@ -53,7 +53,7 @@ void
Tcl_Encoding
\fBTcl_CreateEncoding\fR(\fItypePtr\fR)
.sp
-CONST char *
+const char *
\fBTcl_GetDefaultEncodingDir\fR(\fIvoid\fR)
.sp
void
@@ -64,17 +64,17 @@ void
.AP Tcl_Interp *interp in
Interpreter to use for error reporting, or NULL if no error reporting is
desired.
-.AP "CONST char" *name in
+.AP "const char" *name in
Name of encoding to load.
.AP Tcl_Encoding encoding in
The encoding to query, free, or use for converting text. If \fIencoding\fR is
NULL, the current system encoding is used.
-.AP "CONST char" *src in
+.AP "const char" *src in
For the \fBTcl_ExternalToUtf\fR functions, an array of bytes in the
specified encoding that are to be converted to UTF-8. For the
\fBTcl_UtfToExternal\fR and \fBTcl_WinUtfToTChar\fR functions, an array of
UTF-8 characters to be converted to the specified encoding.
-.AP "CONST TCHAR" *tsrc in
+.AP "const TCHAR" *tsrc in
An array of Windows TCHAR characters to convert to UTF-8.
.AP int srcLen in
Length of \fIsrc\fR or \fItsrc\fR in bytes. If the length is negative, the
@@ -123,7 +123,7 @@ Filled with the number of characters that correspond to the number of bytes
stored in the output buffer. May be NULL.
.AP Tcl_EncodingType *typePtr in
Structure that defines a new type of encoding.
-.AP "CONST char" *path in
+.AP "const char" *path in
A path to the location of the encoding file.
.BE
.SH INTRODUCTION
@@ -303,7 +303,7 @@ convert between this encoding and UTF-8. It is defined as follows:
.PP
.CS
typedef struct Tcl_EncodingType {
- CONST char *\fIencodingName\fR;
+ const char *\fIencodingName\fR;
Tcl_EncodingConvertProc *\fItoUtfProc\fR;
Tcl_EncodingConvertProc *\fIfromUtfProc\fR;
Tcl_EncodingFreeProc *\fIfreeProc\fR;
@@ -339,7 +339,7 @@ type \fBTcl_EncodingConvertProc\fR:
.CS
typedef int Tcl_EncodingConvertProc(
ClientData \fIclientData\fR,
- CONST char *\fIsrc\fR,
+ const char *\fIsrc\fR,
int \fIsrcLen\fR,
int \fIflags\fR,
Tcl_EncodingState *\fIstatePtr\fR,