diff options
| author | Karl Williamson <public@khwilliamson.com> | 2010-09-23 21:26:47 -0600 |
|---|---|---|
| committer | Steffen Mueller <smueller@cpan.org> | 2010-09-25 11:15:32 +0200 |
| commit | 8eea39dda497d40e67ca52cc97f1fe9318b032c2 (patch) | |
| tree | 904feb2f7d43ed70f8cc7ceef14dd97180db6876 /handy.h | |
| parent | 2787a47041484975ffe4cc3d1e3108eb70de1179 (diff) | |
| download | perl-8eea39dda497d40e67ca52cc97f1fe9318b032c2.tar.gz | |
handy.h: Make isWORDCHAR() primary documentation
This macro is clearer as to intent over isALNUM, and isn't confusable
with isALNUMC. So document it primarily.
Diffstat (limited to 'handy.h')
| -rw-r--r-- | handy.h | 13 |
1 files changed, 8 insertions, 5 deletions
@@ -445,11 +445,6 @@ platforms, they use the code page of the platform. The code pages that Perl knows about all have 8-bit characters, so most of these functions will return true for more characters than on ASCII platforms. -=for apidoc Am|bool|isALNUM|char ch -Returns a boolean indicating whether the specified character is an -alphanumeric character (including underscore) in the platform's native -character set. - =for apidoc Am|bool|isALPHA|char ch Returns a boolean indicating whether the specified character is an alphabetic character in the platform's native character set. @@ -474,6 +469,14 @@ whitespace character in the platform's native character set. Returns a boolean indicating whether the specified character is an uppercase character in the platform's native character set. +=for apidoc Am|bool|isWORDCHAR|char ch +Returns a boolean indicating whether the specified character is a +character that is any of: alphabetic, numeric, or an underscore. This is the +same as what C<\w> matches in a regular expression. +C<isALNUM()> is a synonym provided for backward compatibility. Note that it +does not have the standard C language meaning of alphanumeric, since it matches +an underscore and the standard meaning does not. + =head1 Character case changing =for apidoc Am|char|toUPPER|char ch |