diff --git a/icu4c/source/common/unicode/ubiditransform.h b/icu4c/source/common/unicode/ubiditransform.h index 2dd7564010d..24433aa8aca 100644 --- a/icu4c/source/common/unicode/ubiditransform.h +++ b/icu4c/source/common/unicode/ubiditransform.h @@ -28,7 +28,7 @@ /** * \file - * \brief Bidi Transformations + * \brief C API: Bidi Transformations */ /** diff --git a/icu4c/source/common/unicode/ucnv_cb.h b/icu4c/source/common/unicode/ucnv_cb.h index 41845d1bcae..b4ef99208b1 100644 --- a/icu4c/source/common/unicode/ucnv_cb.h +++ b/icu4c/source/common/unicode/ucnv_cb.h @@ -15,8 +15,8 @@ */ /** - * \file - * \brief C UConverter functions to aid the writers of callbacks + * \file + * \brief C API: UConverter functions to aid the writers of callbacks * *

Callback API for UConverter

* diff --git a/icu4c/source/common/unicode/ucnv_err.h b/icu4c/source/common/unicode/ucnv_err.h index a13d01db099..c743e5614f4 100644 --- a/icu4c/source/common/unicode/ucnv_err.h +++ b/icu4c/source/common/unicode/ucnv_err.h @@ -12,7 +12,7 @@ /** * \file - * \brief C UConverter predefined error callbacks + * \brief C API: UConverter predefined error callbacks * *

Error Behaviour Functions

* Defines some error behaviour functions called by ucnv_{from,to}Unicode diff --git a/icu4c/source/common/unicode/ucnvsel.h b/icu4c/source/common/unicode/ucnvsel.h index 3d7d3327f7d..9373ec951bf 100644 --- a/icu4c/source/common/unicode/ucnvsel.h +++ b/icu4c/source/common/unicode/ucnvsel.h @@ -36,6 +36,7 @@ /** * \file + * \brief C API: Encoding/charset encoding selector * * A converter selector is built with a set of encoding/charset names * and given an input string returns the set of names of the diff --git a/icu4c/source/common/unicode/ucpmap.h b/icu4c/source/common/unicode/ucpmap.h index 31e1365cac8..a740bd160fc 100644 --- a/icu4c/source/common/unicode/ucpmap.h +++ b/icu4c/source/common/unicode/ucpmap.h @@ -13,8 +13,7 @@ U_CDECL_BEGIN /** * \file - * - * This file defines an abstract map from Unicode code points to integer values. + * \brief C API: This file defines an abstract map from Unicode code points to integer values. * * @see UCPMap * @see UCPTrie diff --git a/icu4c/source/common/unicode/ucptrie.h b/icu4c/source/common/unicode/ucptrie.h index e2547ae2eea..dadef79c512 100644 --- a/icu4c/source/common/unicode/ucptrie.h +++ b/icu4c/source/common/unicode/ucptrie.h @@ -19,8 +19,7 @@ U_CDECL_BEGIN /** * \file - * - * This file defines an immutable Unicode code point trie. + * \brief C API: This file defines an immutable Unicode code point trie. * * @see UCPTrie * @see UMutableCPTrie diff --git a/icu4c/source/common/unicode/uloc.h b/icu4c/source/common/unicode/uloc.h index b0bdbe1b87f..21179c1b628 100644 --- a/icu4c/source/common/unicode/uloc.h +++ b/icu4c/source/common/unicode/uloc.h @@ -26,9 +26,9 @@ #include "unicode/utypes.h" #include "unicode/uenum.h" -/** +/** * \file - * \brief C API: Locale + * \brief C API: Locale ID functionality similar to C++ class Locale * *

ULoc C API for Locale

* A Locale represents a specific geographical, political, diff --git a/icu4c/source/common/unicode/umisc.h b/icu4c/source/common/unicode/umisc.h index 213290b9afa..4e9dda7450b 100644 --- a/icu4c/source/common/unicode/umisc.h +++ b/icu4c/source/common/unicode/umisc.h @@ -21,9 +21,9 @@ /** * \file - * \brief C API:misc definitions + * \brief C API: Miscellaneous definitions * - * This file contains miscellaneous definitions for the C APIs. + * This file contains miscellaneous definitions for the C APIs. */ U_CDECL_BEGIN diff --git a/icu4c/source/common/unicode/umutablecptrie.h b/icu4c/source/common/unicode/umutablecptrie.h index 3b950055da7..d60fd618191 100644 --- a/icu4c/source/common/unicode/umutablecptrie.h +++ b/icu4c/source/common/unicode/umutablecptrie.h @@ -21,8 +21,7 @@ U_CDECL_BEGIN /** * \file - * - * This file defines a mutable Unicode code point trie. + * \brief C API: This file defines a mutable Unicode code point trie. * * @see UCPTrie * @see UMutableCPTrie diff --git a/icu4c/source/i18n/unicode/displayoptions.h b/icu4c/source/i18n/unicode/displayoptions.h index 68ae901a6ab..6629bf94865 100644 --- a/icu4c/source/i18n/unicode/displayoptions.h +++ b/icu4c/source/i18n/unicode/displayoptions.h @@ -10,6 +10,13 @@ #if !UCONFIG_NO_FORMATTING +/** + * \file + * \brief C++ API: Display options class + * + * This class is designed as a more modern version of the UDisplayContext mechanism. + */ + #include "unicode/udisplayoptions.h" #include "unicode/uversion.h" diff --git a/icu4c/source/i18n/unicode/regex.h b/icu4c/source/i18n/unicode/regex.h index 616ca8f36fd..39b97441a49 100644 --- a/icu4c/source/i18n/unicode/regex.h +++ b/icu4c/source/i18n/unicode/regex.h @@ -22,7 +22,7 @@ /** * \file - * \brief C++ API: Regular Expressions + * \brief C++ API: Regular Expressions * * The ICU API for processing regular expressions consists of two classes, * `RegexPattern` and `RegexMatcher`. diff --git a/icu4c/source/i18n/unicode/udisplayoptions.h b/icu4c/source/i18n/unicode/udisplayoptions.h index ed210c7a675..1ecdf1d8e94 100644 --- a/icu4c/source/i18n/unicode/udisplayoptions.h +++ b/icu4c/source/i18n/unicode/udisplayoptions.h @@ -8,6 +8,14 @@ #if !UCONFIG_NO_FORMATTING +/** + * \file + * \brief C API: Display options (enum types, values, helper functions) + * + * These display options are designed to be used in class DisplayOptions + * as a more modern version of the UDisplayContext mechanism. + */ + #include "unicode/uversion.h" #ifndef U_HIDE_DRAFT_API @@ -111,8 +119,9 @@ U_CAPI const char * U_EXPORT2 udispopt_getPluralCategoryIdentifier(UDisplayOptionsPluralCategory pluralCategory); /** - * @param keyword for example "few" or "other" - * @return the plural category corresponding to the keyword, or `UDISPOPT_PLURAL_CATEGORY_UNDEFINED` + * @param identifier for example "few" or "other" + * @return the plural category corresponding to the identifier (plural keyword), + * or `UDISPOPT_PLURAL_CATEGORY_UNDEFINED` * * @draft ICU 72 */ diff --git a/icu4c/source/i18n/unicode/unumberformatter.h b/icu4c/source/i18n/unicode/unumberformatter.h index 58a75baf073..253b30b5342 100644 --- a/icu4c/source/i18n/unicode/unumberformatter.h +++ b/icu4c/source/i18n/unicode/unumberformatter.h @@ -16,7 +16,7 @@ /** * \file - * \brief C-compatible API for localized number formatting; not recommended for C++. + * \brief C API: Localized number formatting; not recommended for C++. * * This is the C-compatible version of the NumberFormatter API introduced in ICU 60. C++ users should * include unicode/numberformatter.h and use the proper C++ APIs. diff --git a/icu4c/source/i18n/unicode/unumberrangeformatter.h b/icu4c/source/i18n/unicode/unumberrangeformatter.h index 4e92fe29e25..106942f25af 100644 --- a/icu4c/source/i18n/unicode/unumberrangeformatter.h +++ b/icu4c/source/i18n/unicode/unumberrangeformatter.h @@ -17,7 +17,7 @@ /** * \file - * \brief C-compatible API for localized number range formatting. + * \brief C API: Localized number range formatting * * This is the C-compatible version of the NumberRangeFormatter API. C++ users * should include unicode/numberrangeformatter.h and use the proper C++ APIs. diff --git a/icu4c/source/i18n/unicode/uspoof.h b/icu4c/source/i18n/unicode/uspoof.h index b674c91b2c2..0aa887b7066 100644 --- a/icu4c/source/i18n/unicode/uspoof.h +++ b/icu4c/source/i18n/unicode/uspoof.h @@ -35,7 +35,7 @@ /** * \file - * \brief Unicode Security and Spoofing Detection, C API. + * \brief C API: Unicode Security and Spoofing Detection * *

* This class, based on Unicode Technical Report #36 and