diff options
| -rw-r--r-- | ChangeLog | 11 | ||||
| -rw-r--r-- | doc/UniCharIsAlpha.3 | 92 | ||||
| -rw-r--r-- | unix/Makefile.in | 20 | ||||
| -rw-r--r-- | unix/mkLinks | 24 |
4 files changed, 146 insertions, 1 deletions
@@ -1,5 +1,16 @@ 2001-04-07 Andreas Kupries <andreas_kupries@users.sourceforge.net> + * 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-07 Andreas Kupries <andreas_kupries@users.sourceforge.net> + * unix/mkLinks: Updated to incorporate the changes below. * doc/StringObj.3: Added 'Tcl_AttemptSetObjLength' to the NAME diff --git a/doc/UniCharIsAlpha.3 b/doc/UniCharIsAlpha.3 new file mode 100644 index 0000000..1e4b4e9 --- /dev/null +++ b/doc/UniCharIsAlpha.3 @@ -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: UniCharIsAlpha.3,v 1.1 2001/04/06 23:29:17 andreas_kupries 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 diff --git a/unix/Makefile.in b/unix/Makefile.in index 1c8e612..f59fef4 100644 --- a/unix/Makefile.in +++ b/unix/Makefile.in @@ -5,7 +5,7 @@ # "autoconf" program (constructs like "@foo@" will get replaced in the # actual Makefile. # -# RCS: @(#) $Id: Makefile.in,v 1.72 2001/04/04 07:13:52 hobbs Exp $ +# RCS: @(#) $Id: Makefile.in,v 1.73 2001/04/06 23:29:17 andreas_kupries Exp $ VERSION = @TCL_VERSION@ @@ -1069,6 +1069,24 @@ checkstubs: 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. # diff --git a/unix/mkLinks b/unix/mkLinks index ae25177..d0b8d5c 100644 --- a/unix/mkLinks +++ b/unix/mkLinks @@ -972,6 +972,30 @@ if test -r Translate.3; then 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 |