Attachment "ak.218720.0.diff" to
ticket [218720ffff]
added by
andreas_kupries
2001-04-07 05:39:36.
Index: ChangeLog
===================================================================
RCS file: /cvsroot/tcl/tcl/ChangeLog,v
retrieving revision 1.410
diff -u -r1.410 ChangeLog
--- ChangeLog 2001/04/06 17:57:31 1.410
+++ ChangeLog 2001/04/06 20:18:52
@@ -1,3 +1,14 @@
+2001-04-06 Andreas Kupries <[email protected]>
+
+ * unix/Makefile.in (checkdoc): New target, checking the
+ definitions as found in the compiled library against the
+ manpages to find undocumented public functionality.
+
+ * unix/mkLinks: Updated to include the new manpage.
+
+ * doc/UniCharIsAlpha.3: New manpage documenting the Unicode
+ character classification APIs [Bug #218720].
+
2001-04-06 Don Porter <[email protected]>
* library/init.tcl:
Index: doc/UniCharIsAlpha.3
===================================================================
RCS file: UniCharIsAlpha.3
diff -N UniCharIsAlpha.3
--- /dev/null Mon Dec 11 17:26:27 2000
+++ UniCharIsAlpha.3 Fri Apr 6 13:18:52 2001
@@ -0,0 +1,92 @@
+'\"
+'\" Copyright (c) 1997 Sun Microsystems, Inc.
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" RCS: @(#) $Id: Utf.3,v 1.8 2000/05/08 22:00:01 hobbs Exp $
+'\"
+.so man.macros
+.TH Tcl_UniCharIsAlpha 3 "8.1" Tcl "Tcl Library Procedures"
+.BS
+.SH NAME
+Tcl_UniCharIsAlnum, Tcl_UniCharIsAlpha, Tcl_UniCharIsControl, Tcl_UniCharIsDigit, Tcl_UniCharIsGraph, Tcl_UniCharIsLower, Tcl_UniCharIsPrint, Tcl_UniCharIsPunct, Tcl_UniCharIsSpace, Tcl_UniCharIsUpper, Tcl_UniCharIsWordChar \- routines for classification of Tcl_UniChar characters
+.SH SYNOPSIS
+.nf
+\fB#include <tcl.h>\fR
+.sp
+int
+\fBTcl_UniCharIsAlnum\fR(\fIch\fR)
+.sp
+int
+\fBTcl_UniCharIsAlpha\fR(\fIch\fR)
+.sp
+int
+\fBTcl_UniCharIsControl\fR(\fIch\fR)
+.sp
+int
+\fBTcl_UniCharIsDigit\fR(\fIch\fR)
+.sp
+int
+\fBTcl_UniCharIsGraph\fR(\fIch\fR)
+.sp
+int
+\fBTcl_UniCharIsLower\fR(\fch\fR)
+.sp
+int
+\fBTcl_UniCharIsPrint\fR(\fch\fR)
+.sp
+int
+\fBTcl_UniCharIsPunct\fR(\fch\fR)
+.sp
+int
+\fBTcl_UniCharIsSpace\fR(\fIch\fR)
+.sp
+int
+\fBTcl_UniCharIsUpper\fR(\fIch\fR)
+.sp
+int
+\fBTcl_UniCharIsWordChar\fR(\fIch\fR)
+.SH ARGUMENTS
+.AP int ch in
+The Tcl_UniChar to be examined.
+.BE
+
+.SH DESCRIPTION
+.PP
+All of the routines described examine Tcl_UniChars and return a
+boolean value. A non-zero return value means that the character does
+belong to the character class associated with the called routine. The
+rest of this document just describes the character classes associated
+with the various routines.
+.PP
+Note: A Tcl_UniChar is a Unicode character represented as an unsigned,
+fixed-size quantity.
+
+.SH CHARACTER CLASSES
+.PP
+\fBTcl_UniCharIsAlnum\fR tests if the character is an alphanumeric Unicode character.
+.PP
+\fBTcl_UniCharIsAlpha\fR tests if the character is an alphabetic Unicode character.
+.PP
+\fBTcl_UniCharIsControl\fR tests if the character is a Unicode control character.
+.PP
+\fBTcl_UniCharIsDigit\fR tests if the character is a numeric Unicode character.
+.PP
+\fBTcl_UniCharIsGraph\fR tests if the character is any Unicode print character except space.
+.PP
+\fBTcl_UniCharIsLower\fR tests if the character is a lowercase Unicode character.
+.PP
+\fBTcl_UniCharIsPrint\fR tests if the character is a Unicode print character.
+.PP
+\fBTcl_UniCharIsPunct\fR tests if the character is a Unicode punctuation character.
+.PP
+\fBTcl_UniCharIsSpace\fR tests if the character is a whitespace Unicode character.
+.PP
+\fBTcl_UniCharIsUpper\fR tests if the character is an uppercase Unicode character.
+.PP
+\fBTcl_UniCharIsWordChar\fR tests if the character is alphanumeric or
+a connector punctuation mark.
+
+.SH KEYWORDS
+unicode, classification
Index: unix/Makefile.in
===================================================================
RCS file: /cvsroot/tcl/tcl/unix/Makefile.in,v
retrieving revision 1.72
diff -u -r1.72 Makefile.in
--- unix/Makefile.in 2001/04/04 07:13:52 1.72
+++ unix/Makefile.in 2001/04/06 20:18:58
@@ -1069,6 +1069,24 @@
done
#
+# Target to check that all public APIs which are not command
+# implementations have an entry in section three of the distributed
+# manpages.
+#
+
+checkdoc:
+ -@for i in `nm -p $(TCL_LIB_FILE) | awk '$$3 ~ /Tcl_/ { print $$3 }' \
+ | grep -v 'Cmd$$' | sort -n`; do \
+ match=0; \
+ for j in $(TOP_DIR)/doc/*.3; do \
+ if [ `grep '\-' $$j | grep -c $$i` -gt 0 ]; then \
+ match=1; \
+ fi; \
+ done; \
+ if [ $$match -eq 0 ]; then echo $$i; fi \
+ done
+
+#
# Target to check for proper usage of UCHAR macro.
#
Index: unix/mkLinks
===================================================================
RCS file: /cvsroot/tcl/tcl/unix/mkLinks,v
retrieving revision 1.22
diff -u -r1.22 mkLinks
--- unix/mkLinks 2001/04/05 15:14:59 1.22
+++ unix/mkLinks 2001/04/06 20:18:59
@@ -966,6 +966,30 @@
rm -f Tcl_TranslateFileName.3
ln Translate.3 Tcl_TranslateFileName.3
fi
+if test -r UniCharIsAlpha.3; then
+ rm -f Tcl_UniCharIsAlnum.3
+ rm -f Tcl_UniCharIsAlpha.3
+ rm -f Tcl_UniCharIsControl.3
+ rm -f Tcl_UniCharIsDigit.3
+ rm -f Tcl_UniCharIsGraph.3
+ rm -f Tcl_UniCharIsLower.3
+ rm -f Tcl_UniCharIsPrint.3
+ rm -f Tcl_UniCharIsPunct.3
+ rm -f Tcl_UniCharIsSpace.3
+ rm -f Tcl_UniCharIsUpper.3
+ rm -f Tcl_UniCharIsWordChar.3
+ ln UniCharIsAlpha.3 Tcl_UniCharIsAlnum.3
+ ln UniCharIsAlpha.3 Tcl_UniCharIsAlpha.3
+ ln UniCharIsAlpha.3 Tcl_UniCharIsControl.3
+ ln UniCharIsAlpha.3 Tcl_UniCharIsDigit.3
+ ln UniCharIsAlpha.3 Tcl_UniCharIsGraph.3
+ ln UniCharIsAlpha.3 Tcl_UniCharIsLower.3
+ ln UniCharIsAlpha.3 Tcl_UniCharIsPrint.3
+ ln UniCharIsAlpha.3 Tcl_UniCharIsPunct.3
+ ln UniCharIsAlpha.3 Tcl_UniCharIsSpace.3
+ ln UniCharIsAlpha.3 Tcl_UniCharIsUpper.3
+ ln UniCharIsAlpha.3 Tcl_UniCharIsWordChar.3
+fi
if test -r UpVar.3; then
rm -f Tcl_UpVar.3
rm -f Tcl_UpVar2.3
