ICU-21959 fix file-level doxygen issues

diff --git a/icu4c/source/common/unicode/ubiditransform.h b/icu4c/source/common/unicode/ubiditransform.h
index 2dd7564010de17e5b773bf35bc6235a000d76b2d..24433aa8aca0fca2b69ac0eebcb6fd3956c26f61 100644 (file)
--- 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 41845d1bcaeabe1a8084b9bc05dc4e93c1d8b3a8..b4ef99208b15dd81eb082266231bf5c385f24a60 100644 (file)
--- 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
  *
  * <h2> Callback API for UConverter </h2>
  * 

diff --git a/icu4c/source/common/unicode/ucnv_err.h b/icu4c/source/common/unicode/ucnv_err.h
index a13d01db099b37991d055a3206fa7741a1fb1078..c743e5614f4ade2986544370eac038805f27d4bf 100644 (file)
--- 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
  *
  *  <h2>Error Behaviour Functions</h2>
  *  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 3d7d3327f7daddd94cc843cab19655a06a20353d..9373ec951bf83a65fe47abc277639e89ff09b22c 100644 (file)
--- 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 31e1365cac850a45709cc5aa1b1557af872a2769..a740bd160fc155367d54439eccc8af02fb62d885 100644 (file)
--- 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 e2547ae2eeac92c642cfeb0354c66d9963d6d067..dadef79c5120495be7e87ba95a0da149b9605f90 100644 (file)
--- 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 b0bdbe1b87f48f8c0b789a49e9570488a63bdde5..21179c1b628e1cecbbb8a83fcff64b1d622ef46f 100644 (file)
--- 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
  *
  * <h2> ULoc C API for Locale </h2>
  * A <code>Locale</code> represents a specific geographical, political,

diff --git a/icu4c/source/common/unicode/umisc.h b/icu4c/source/common/unicode/umisc.h
index 213290b9afa33cfdbdb0605c79e550df333f5ccc..4e9dda7450bdc48981ee3f78017e16b2c9a95f47 100644 (file)
--- 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 3b950055da7e68d53f2ee74fc0b87fe30e41173b..d60fd618191c480196039ed3a448cf423ba4c8f6 100644 (file)
--- 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 68ae901a6aba04fcae4e0671df00c1a4f5a76a36..6629bf948656cfffbc4e34c9dcda79c3f86b095d 100644 (file)
--- 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 616ca8f36fd7f85b25dac15416fb70ee214066e9..39b97441a49d758dd25b089db8c394c51314b4a5 100644 (file)
--- 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 ed210c7a675befbf85d8d8c67634db8286dd7de8..1ecdf1d8e94463fd1b75f3f13690f466d0c4df2b 100644 (file)
--- 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 58a75baf073c43673914b9191db9498b41c3c174..253b30b5342e077df1d2c3f7315d81836808608a 100644 (file)
--- 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 4e92fe29e250599bf8b828f108f7ba7c159ee6aa..106942f25af0b93288464febf8f44da720f24629 100644 (file)
--- 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 b674c91b2c246ca643c65cc201088c2464fe033d..0aa887b70661bbf087c1bb48d70ae78ffdbe2369 100644 (file)
--- 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
  *
  * <p>
  * This class, based on <a href="http://unicode.org/reports/tr36">Unicode Technical Report #36</a> and