ICU-13833 Fixing doxygen warnings in numberformatter.h and other files. (#140)
This commit is contained in:
Shane F. Carr
Shane Carr
parent
531bc76ed5
commit
9052b89018
@ -243,7 +243,7 @@ ALIASES = "memo=\par Note:\n" \
|
||||
"obsolete=\xrefitem obsolete \"Obsolete\" \"Obsolete List\"" \
|
||||
"system=\xrefitem system \"System\" \"System List\" \n Do not use unless you know what you are doing." \
|
||||
"internal=\xrefitem internal \"Internal\" \"Internal List\" Do not use. This API is for internal use only." \
|
||||
"preview=\xrefitem preview \"Preview\" \"Preview List\" This API is a technical preview. It may change in an upcoming release.
|
||||
"preview=\xrefitem preview \"Preview\" \"Preview List\" This API is a technical preview. It may change in an upcoming release."
|
||||
|
||||
# This tag can be used to specify a number of word-keyword mappings (TCL only).
|
||||
# A mapping has the form "name=value". For example adding "class=itcl::class"
|
||||
|
||||
@ -151,7 +151,7 @@ class U_I18N_API ListFormatter : public UObject{
|
||||
* @param posIter On return, can be used to iterate over positions of
|
||||
* fields generated by this format call. Field values are
|
||||
* defined in UListFormatterField. Can be NULL.
|
||||
* @param status ICU error code returned here.
|
||||
* @param errorCode ICU error code returned here.
|
||||
* @return Formatted string combining the elements of items,
|
||||
* appended to appendTo.
|
||||
* @draft ICU 63
|
||||
|
||||
@ -146,12 +146,29 @@ class GeneratorHelpers;
|
||||
class DecNum;
|
||||
class NumberRangeFormatterImpl;
|
||||
struct RangeMacroProps;
|
||||
|
||||
/**
|
||||
* Used for NumberRangeFormatter and implemented in numrange_fluent.cpp.
|
||||
* Declared here so it can be friended.
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
void touchRangeLocales(impl::RangeMacroProps& macros);
|
||||
|
||||
} // namespace impl
|
||||
|
||||
// Reserve extra names in case they are added as classes in the future:
|
||||
/**
|
||||
* Extra name reserved in case it is needed in the future.
|
||||
*
|
||||
* @draft ICU 63
|
||||
*/
|
||||
typedef Notation CompactNotation;
|
||||
|
||||
/**
|
||||
* Extra name reserved in case it is needed in the future.
|
||||
*
|
||||
* @draft ICU 63
|
||||
*/
|
||||
typedef Notation SimpleNotation;
|
||||
|
||||
/**
|
||||
@ -311,10 +328,15 @@ class U_I18N_API Notation : public UMemory {
|
||||
|
||||
union NotationUnion {
|
||||
// For NTN_SCIENTIFIC
|
||||
/** @internal */
|
||||
struct ScientificSettings {
|
||||
/** @internal */
|
||||
int8_t fEngineeringInterval;
|
||||
/** @internal */
|
||||
bool fRequireMinInt;
|
||||
/** @internal */
|
||||
impl::digits_t fMinExponentDigits;
|
||||
/** @internal */
|
||||
UNumberSignDisplay fExponentSignDisplay;
|
||||
} scientific;
|
||||
|
||||
@ -410,15 +432,39 @@ class U_I18N_API ScientificNotation : public Notation {
|
||||
friend class impl::NumberPropertyMapper;
|
||||
};
|
||||
|
||||
// Reserve extra names in case they are added as classes in the future:
|
||||
/**
|
||||
* Extra name reserved in case it is needed in the future.
|
||||
*
|
||||
* @draft ICU 63
|
||||
*/
|
||||
typedef Precision SignificantDigitsPrecision;
|
||||
|
||||
// Typedefs for ICU 60/61 compatibility.
|
||||
// These will be removed in ICU 64.
|
||||
// See http://bugs.icu-project.org/trac/ticket/13746
|
||||
|
||||
/**
|
||||
* This will be removed in ICU 64. See ICU-13746.
|
||||
* @deprecated ICU 63
|
||||
*/
|
||||
typedef Precision Rounder;
|
||||
|
||||
/**
|
||||
* This will be removed in ICU 64. See ICU-13746.
|
||||
* @deprecated ICU 63
|
||||
*/
|
||||
typedef FractionPrecision FractionRounder;
|
||||
|
||||
/**
|
||||
* This will be removed in ICU 64. See ICU-13746.
|
||||
* @deprecated ICU 63
|
||||
*/
|
||||
typedef IncrementPrecision IncrementRounder;
|
||||
|
||||
/**
|
||||
* This will be removed in ICU 64. See ICU-13746.
|
||||
* @deprecated ICU 63
|
||||
*/
|
||||
typedef CurrencyPrecision CurrencyRounder;
|
||||
|
||||
/**
|
||||
@ -675,16 +721,25 @@ class U_I18N_API Precision : public UMemory {
|
||||
} fType;
|
||||
|
||||
union PrecisionUnion {
|
||||
/** @internal */
|
||||
struct FractionSignificantSettings {
|
||||
// For RND_FRACTION, RND_SIGNIFICANT, and RND_FRACTION_SIGNIFICANT
|
||||
/** @internal */
|
||||
impl::digits_t fMinFrac;
|
||||
/** @internal */
|
||||
impl::digits_t fMaxFrac;
|
||||
/** @internal */
|
||||
impl::digits_t fMinSig;
|
||||
/** @internal */
|
||||
impl::digits_t fMaxSig;
|
||||
} fracSig;
|
||||
/** @internal */
|
||||
struct IncrementSettings {
|
||||
/** @internal */
|
||||
double fIncrement;
|
||||
/** @internal */
|
||||
impl::digits_t fMinFrac;
|
||||
/** @internal */
|
||||
impl::digits_t fMaxFrac;
|
||||
} increment; // For RND_INCREMENT
|
||||
UCurrencyUsage currencyUsage; // For RND_CURRENCY
|
||||
@ -1737,7 +1792,6 @@ class U_I18N_API NumberFormatterSettings {
|
||||
* The grouping strategy to use.
|
||||
* @return The fluent chain.
|
||||
* @see #grouping
|
||||
* @provisional This API might change or be removed in a future release.
|
||||
* @draft ICU 62
|
||||
*/
|
||||
Derived grouping(UGroupingStrategy strategy) &&;
|
||||
@ -1752,7 +1806,7 @@ class U_I18N_API NumberFormatterSettings {
|
||||
* </ul>
|
||||
*
|
||||
* <p>
|
||||
* Pass this method the return value of {@link IntegerWidth#zeroFillTo(int)}. For example:
|
||||
* Pass this method the return value of {@link IntegerWidth#zeroFillTo}. For example:
|
||||
*
|
||||
* <pre>
|
||||
* NumberFormatter::with().integerWidth(IntegerWidth::zeroFillTo(2))
|
||||
@ -2103,10 +2157,9 @@ class U_I18N_API NumberFormatterSettings {
|
||||
|
||||
// NOTE: Uses default copy and move constructors.
|
||||
|
||||
protected:
|
||||
private:
|
||||
impl::MacroProps fMacros;
|
||||
|
||||
private:
|
||||
// Don't construct me directly! Use (Un)LocalizedNumberFormatter.
|
||||
NumberFormatterSettings() = default;
|
||||
|
||||
@ -2332,6 +2385,7 @@ class U_I18N_API LocalizedNumberFormatter
|
||||
*
|
||||
* @param results
|
||||
* The results object. This method will mutate it to save the results.
|
||||
* @param status
|
||||
* @internal
|
||||
*/
|
||||
void formatImpl(impl::UFormattedNumberData *results, UErrorCode &status) const;
|
||||
|
||||
@ -596,6 +596,9 @@ class U_I18N_API LocalizedNumberRangeFormatter
|
||||
/**
|
||||
* @param results
|
||||
* The results object. This method will mutate it to save the results.
|
||||
* @param equalBeforeRounding
|
||||
* Whether the number was equal before copying it into a DecimalQuantity.
|
||||
* Used for determining the identity fallback behavior.
|
||||
* @param status
|
||||
* Set if an error occurs while formatting.
|
||||
* @internal
|
||||
|
||||
@ -91,7 +91,7 @@
|
||||
* </ul>
|
||||
*
|
||||
* <p>
|
||||
* This enum is similar to {@link com.ibm.icu.text.MeasureFormat.FormatWidth}.
|
||||
* This enum is similar to {@link UMeasureFormatWidth}.
|
||||
*
|
||||
* @draft ICU 60
|
||||
*/
|
||||
@ -398,6 +398,8 @@ typedef enum UNumberDecimalSeparatorDisplay {
|
||||
#endif /* U_HIDE_DRAFT_API */
|
||||
|
||||
#ifndef U_HIDE_DRAFT_API
|
||||
|
||||
struct UNumberFormatter;
|
||||
/**
|
||||
* C-compatible version of icu::number::LocalizedNumberFormatter.
|
||||
*
|
||||
@ -405,10 +407,9 @@ typedef enum UNumberDecimalSeparatorDisplay {
|
||||
*
|
||||
* @draft ICU 62
|
||||
*/
|
||||
struct UNumberFormatter;
|
||||
typedef struct UNumberFormatter UNumberFormatter;
|
||||
|
||||
|
||||
struct UFormattedNumber;
|
||||
/**
|
||||
* C-compatible version of icu::number::FormattedNumber.
|
||||
*
|
||||
@ -416,7 +417,6 @@ typedef struct UNumberFormatter UNumberFormatter;
|
||||
*
|
||||
* @draft ICU 62
|
||||
*/
|
||||
struct UFormattedNumber;
|
||||
typedef struct UFormattedNumber UFormattedNumber;
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user