organicmaps/icu
13
Fork 0
mirror of https://github.com/unicode-org/icu.git synced 2025-04-13 08:53:20 +00:00
Code Issues1 Projects Releases Wiki Activity Actions3

ICU-21959 fix file-level doxygen issues

Browse source
This commit is contained in:
Markus Scherer 2022-09-26 17:21:17 -07:00
parent e5980f1dcb
commit e72233f8b7
15 changed files with 34 additions and 20 deletions

2
icu4c/source/common/unicode/ubiditransform.h
View file

@ -28,7 +28,7 @@
/**
* \file
* \brief Bidi Transformations
* \brief C API: Bidi Transformations
*/
/**

4
icu4c/source/common/unicode/ucnv_cb.h
View file

@ -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>
*

2
icu4c/source/common/unicode/ucnv_err.h
View file

@ -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

1
icu4c/source/common/unicode/ucnvsel.h
View file

@ -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

3
icu4c/source/common/unicode/ucpmap.h
View file

@ -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

3
icu4c/source/common/unicode/ucptrie.h
View file

@ -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

4
icu4c/source/common/unicode/uloc.h
View file

@ -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,

4
icu4c/source/common/unicode/umisc.h
View file

@ -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

3
icu4c/source/common/unicode/umutablecptrie.h
View file

@ -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

7
icu4c/source/i18n/unicode/displayoptions.h
View file

@ -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"

2
icu4c/source/i18n/unicode/regex.h
View file

@ -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`.

13
icu4c/source/i18n/unicode/udisplayoptions.h
View file

@ -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
*/

2
icu4c/source/i18n/unicode/unumberformatter.h
View file

@ -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.

2
icu4c/source/i18n/unicode/unumberrangeformatter.h
View file

@ -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.

2
icu4c/source/i18n/unicode/uspoof.h
View file

@ -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