# HG changeset patch # User Bruno Haible # Date 1238926485 -7200 # Node ID 1b9f62427f8b1bfbd880290d78ad880214566731 # Parent 26ca89ce898a10092b84e883faf4b6335d931dc1 Doc fixes. diff --git a/ChangeLog b/ChangeLog --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2009-04-05 Bruno Haible + + * lib/unistr.h: Doc fixes. + * lib/uniconv.h: Doc fixes. + * lib/unictype.h: Doc fixes. + 2009-04-03 Paul Eggert Port coreutils 7.2 to Solaris 8. diff --git a/lib/uniconv.h b/lib/uniconv.h --- a/lib/uniconv.h +++ b/lib/uniconv.h @@ -1,5 +1,5 @@ /* Conversions between Unicode and legacy encodings. - Copyright (C) 2002, 2005, 2007 Free Software Foundation, Inc. + Copyright (C) 2002, 2005, 2007, 2009 Free Software Foundation, Inc. This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published @@ -47,7 +47,7 @@ array is filled with offsets into the result, i.e. the character starting at SRC[i] corresponds to the character starting at (*RESULTP)[OFFSETS[i]], and other offsets are set to (size_t)(-1). - *RESULTP and *LENGTH should initially be a scratch buffer and its size, + *RESULTP and *LENGTHP should initially be a scratch buffer and its size, or *RESULTP can initially be NULL. May erase the contents of the memory at *RESULTP. Return value: 0 if successful, otherwise -1 and errno set. @@ -84,7 +84,7 @@ array is filled with offsets into the result, i.e. the character starting at SRC[i] corresponds to the character starting at (*RESULTP)[OFFSETS[i]], and other offsets are set to (size_t)(-1). - *RESULTP and *LENGTH should initially be a scratch buffer and its size, + *RESULTP and *LENGTHP should initially be a scratch buffer and its size, or *RESULTP can initially be NULL. May erase the contents of the memory at *RESULTP. Return value: 0 if successful, otherwise -1 and errno set. diff --git a/lib/unictype.h b/lib/unictype.h --- a/lib/unictype.h +++ b/lib/unictype.h @@ -56,7 +56,8 @@ /* Bits and bit masks denoting General category values. UnicodeData-3.2.0.html says a 32-bit integer will always suffice to represent them. - These bit masks are just informative; you cannot use them in any API. */ + These bit masks can only be used with the uc_is_general_category_withtable + function. */ enum { UC_CATEGORY_MASK_L = 0x0000001f, @@ -212,7 +213,7 @@ uc_general_category (ucs4_t uc); /* Test whether a Unicode character belongs to a given category. - The CATEGORY argument can be the combination of several built-in + The CATEGORY argument can be the combination of several predefined general categories. */ extern bool uc_is_general_category (ucs4_t uc, uc_general_category_t category); @@ -547,7 +548,7 @@ /* ========================================================================= */ -/* Subdivision of the the Unicode characters into scripts. */ +/* Subdivision of the Unicode characters into scripts. */ typedef struct { @@ -693,9 +694,8 @@ extern bool uc_is_upper (ucs4_t uc); -/* Test for any character that corresponds to a hexadecimal-digit character - equivalent to that performed by the functions described in the previous - subclause. */ +/* Test for any character that corresponds to a hexadecimal-digit + character. */ extern bool uc_is_xdigit (ucs4_t uc); diff --git a/lib/unistr.h b/lib/unistr.h --- a/lib/unistr.h +++ b/lib/unistr.h @@ -516,8 +516,8 @@ extern uint32_t * u32_strncpy (uint32_t *dest, const uint32_t *src, size_t n); -/* Copy no more than N characters of SRC to DEST, returning the address of - the last character written into DEST. */ +/* Copy no more than N units of SRC to DEST, returning the address of + the last unit written into DEST. */ /* Similar to stpncpy(). */ extern uint8_t * u8_stpncpy (uint8_t *dest, const uint8_t *src, size_t n);