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

ICU-8525 doxygen warnings

Browse source 
X-SVN-Rev: 30029
This commit is contained in:
Steven R. Loomis 2011-05-05 01:35:22 +00:00
parent 33ced448a3
commit 63dd5be23d
29 changed files with 110 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -130,6 +130,9 @@ private:
virtual int32_t getMinLinearMatch() const { return BytesTrie::kMinLinearMatch; }
virtual int32_t getMaxLinearMatchLength() const { return BytesTrie::kMaxLinearMatchLength; }
/**
* @internal
*/
class BTLinearMatchNode : public LinearMatchNode {
public:
BTLinearMatchNode(const char *units, int32_t len, Node *nextNode);

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

@ -1,7 +1,7 @@
/*
******************************************************************************
*
* Copyright (C) 1996-2010, International Business Machines
* Copyright (C) 1996-2011, International Business Machines
* Corporation and others. All Rights Reserved.
*
******************************************************************************
@ -695,6 +695,7 @@ private:
* Was deprecated - used in implementation - moved internal
*
* @param cLocaleID The new locale name.
* @param canonicalize whether to call uloc_canonicalize on cLocaleID
*/
Locale& init(const char* cLocaleID, UBool canonicalize);

16
icu4c/source/common/unicode/messagepattern.h
View file

@ -86,6 +86,9 @@ enum UMessagePatternApostropheMode {
*/
UMSGPAT_APOS_DOUBLE_REQUIRED
};
/**
* @draft ICU 4.8
*/
typedef enum UMessagePatternApostropheMode UMessagePatternApostropheMode;
/**
@ -198,6 +201,9 @@ enum UMessagePatternPartType {
*/
UMSGPAT_PART_TYPE_ARG_DOUBLE
};
/**
* @draft ICU 4.8
*/
typedef enum UMessagePatternPartType UMessagePatternPartType;
/**
@ -242,8 +248,14 @@ enum UMessagePatternArgType {
*/
UMSGPAT_ARG_TYPE_SELECT
};
/**
* @draft ICU 4.8
*/
typedef enum UMessagePatternArgType UMessagePatternArgType;
/**
* @draft ICU 4.8
*/
enum {
/**
* Return value from MessagePattern.validateArgumentName() for when
@ -325,6 +337,7 @@ class MessagePatternPartsList;
* is the value of an explicit-number selector like "=2",
* otherwise the selector is a non-numeric identifier.
* <li>The REPLACE_NUMBER Part can occur only in an immediate sub-message of the pluralStyle.
* </ul>
* <p>
* This class is not intended for public subclassing.
*
@ -486,7 +499,6 @@ public:
* countParts() will return 0.
* @param mode The new UMessagePatternApostropheMode.
* @draft ICU 4.8
* @provisional This API might change or be removed in a future release.
*/
void clearPatternAndSetApostropheMode(UMessagePatternApostropheMode mode) {
clear();
@ -842,6 +854,8 @@ private:
* @param start start index into the message string
* @param limit limit index into the message string, must be start<limit
* @param allowInfinity TRUE if U+221E is allowed (for ChoiceFormat)
* @param parseError
* @param errorCode
*/
void parseDouble(int32_t start, int32_t limit, UBool allowInfinity,
UParseError *parseError, UErrorCode &errorCode);

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

@ -136,7 +136,7 @@ class U_COMMON_API StringPiece : public UMemory {
/**
* Reset the stringpiece to refer to new data.
* @param data pointer the new string data. Need not be nul terminated.
* @param xdata pointer the new string data. Need not be nul terminated.
* @param len the length of the new data
* @draft ICU 4.8
*/

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

@ -365,6 +365,7 @@ typedef int32_t UChar32;
/**
* \def U_INLINE
* This is used to request inlining of a function, on platforms and languages which support it.
* @internal
*/
#ifndef U_INLINE

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

@ -468,6 +468,6 @@ uscript_hasScript(UChar32 c, UScriptCode sc);
U_DRAFT int32_t U_EXPORT2
uscript_getScriptExtensions(UChar32 c,
UScriptCode *scripts, int32_t capacity,
UErrorCode *pErrorCode);
UErrorCode *errorCode);
#endif

14
icu4c/source/common/unicode/utypes.h
View file

@ -68,6 +68,12 @@
/**
* \def U_HIDE_DRAFT_API
* Define this to 1 to request that draft API be "hidden"
* @internal
*/
/**
* \def U_HIDE_INTERNAL_API
* Define this to 1 to request that internal API be "hidden"
* @internal
*/
#if !U_DEFAULT_SHOW_DRAFT && !defined(U_SHOW_DRAFT_API)
#define U_HIDE_DRAFT_API 1
@ -316,10 +322,16 @@ typedef double UDate;
/** The number of milliseconds per day @stable ICU 2.0 */
#define U_MILLIS_PER_DAY (86400000)
/** Maximum and minimum UDate value
/**
* Maximum UDate value
* @draft ICU 4.8
*/
#define U_DATE_MAX DBL_MAX
/**
* Minimum UDate value
* @draft ICU 4.8
*/
#define U_DATE_MIN -U_DATE_MAX

21
icu4c/source/i18n/unicode/alphaindex.h
View file

@ -81,7 +81,7 @@ class UVector;
* class AlphabeticIndex supports the creation of a UI index appropriate for a given language, such as:
*
* <pre>
* <b>... A B C D E F G H I J K L M N O P Q R S T U V W X Y Z \u00C6 \u00D8 \u00C5 ...</b>
* <b>... A B C D E F G H I J K L M N O P Q R S T U V W X Y Z \\u00C6 \\u00D8 \\u00C5 ...</b>
*
* <b>A</b>
* Addison
@ -154,9 +154,9 @@ class UVector;
* <li>Additional collation parameters can be passed in as part of the locale name.
* For example, German plus numeric
* sorting would be "de@kn-true".
* </ul>
*
* @draft ICU 4.8
* @provisional This API might change or be removed in a future release.
* @draft ICU 4.8 This API might change or be removed in a future release.
*/
@ -209,6 +209,7 @@ class U_I18N_API AlphabeticIndex: public UObject {
/**
* Destructor
* @draft ICU 4.8
*/
virtual ~AlphabeticIndex();
@ -312,6 +313,7 @@ class U_I18N_API AlphabeticIndex: public UObject {
* A more sophisticated mechanism may be available in the future.
*
* @param maxLabelCount the maximum number of labels.
* @param status error code
* @return This, for chaining
* @draft ICU 4.8
*/
@ -326,6 +328,7 @@ class U_I18N_API AlphabeticIndex: public UObject {
* would be the <i>Greek-alpha</i>.
*
* @param lowerLimit The character below the overflow (or inflow) bucket
* @param status error code
* @return string that defines top of the overflow buck for lowerLimit, or an empty string if there is none
* @internal
*/
@ -391,7 +394,7 @@ class U_I18N_API AlphabeticIndex: public UObject {
* A Record will not be added to the index by this function.
* Bucket numbers are zero-based, in Bucket iteration order.
*
* @param name The name whose bucket position in the index is to be determined.
* @param itemName The name whose bucket position in the index is to be determined.
* @param status Error code, will be set with the reason if the operation fails.
* @return The bucket number for this name.
* @draft ICU 4.8
@ -594,17 +597,17 @@ private:
UVector *inputRecords_;
/**
* A Bucket holds an index label and references to everything belonging to that label.
* For implementation use only. Declared public because pure C implementation code needs access.
* @internal
* A Bucket holds an index label and references to everything belonging to that label.
* For implementation use only. Declared public because pure C implementation code needs access.
* @internal
*/
struct Bucket: public UMemory {
UnicodeString label_;
UnicodeString lowerBoundary_;
UAlphabeticIndexLabelType labelType_;
UVector *records_; // Records are owned by inputRecords_ vector.
UVector *records_; // Records are owned by inputRecords_ vector.
Bucket(const UnicodeString &label, // Parameter strings are copied.
Bucket(const UnicodeString &label, // Parameter strings are copied.
const UnicodeString &lowerBoundary,
UAlphabeticIndexLabelType type, UErrorCode &status);
~Bucket();

4
icu4c/source/i18n/unicode/calendar.h
View file

@ -1,6 +1,6 @@
/*
********************************************************************************
* Copyright (C) 1997-2010, International Business Machines
* Copyright (C) 1997-2011, International Business Machines
* Corporation and others. All Rights Reserved.
********************************************************************************
*
@ -2084,7 +2084,7 @@ private:
* Validate a single field of this calendar. Subclasses should
* override this method to validate any calendar-specific fields.
* Generic fields can be handled by
* <code>Calendar.validateField()</code>.
* <code>Calendar::validateField()</code>.
* @see #validateField(int, int, int, int&)
* @internal
*/

1
icu4c/source/i18n/unicode/coll.h
View file

@ -621,6 +621,7 @@ public:
* @param reorderCodesLength The length of reorderCodes.
* @see Collator#getReorderCodes
* @see Collator#getEquivalentReorderCodes
* @param status error code
* @draft ICU 4.8
*/
virtual void U_EXPORT2 setReorderCodes(const int32_t* reorderCodes,

3
icu4c/source/i18n/unicode/currpinf.h
View file

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 2009-2010, International Business Machines Corporation and *
* Copyright (C) 2009-2011, International Business Machines Corporation and *
* others. All Rights Reserved. *
*******************************************************************************
*/
@ -221,6 +221,7 @@ private:
*
* @param source the source to copy from
* @param target the target to copy to
* @param status error code
*/
void copyHash(const Hashtable* source, Hashtable* target, UErrorCode& status);

4
icu4c/source/i18n/unicode/datefmt.h
View file

@ -1,6 +1,6 @@
/*
********************************************************************************
* Copyright (C) 1997-2010, International Business Machines
* Copyright (C) 1997-2011, International Business Machines
* Corporation and others. All Rights Reserved.
********************************************************************************
*
@ -680,7 +680,7 @@ private:
* @param inLocale the given locale.
* @return a date/time formatter, or 0 on failure.
*/
static DateFormat* U_EXPORT2 create(EStyle timeStyle, EStyle dateStyle, const Locale&);
static DateFormat* U_EXPORT2 create(EStyle timeStyle, EStyle dateStyle, const Locale& inLocale);
public:
/**

4
icu4c/source/i18n/unicode/dtfmtsym.h
View file

@ -407,7 +407,7 @@ public:
/**
* Sets timezone strings. These strings are stored in a 2-dimensional array.
* <p><b>Note:<b> SimpleDateFormat no longer use the zone strings stored in
* <p><b>Note:</b> SimpleDateFormat no longer use the zone strings stored in
* a DateFormatSymbols. Therefore, the time zone strings set by this mthod
* have no effects in an instance of SimpleDateFormat for formatting time
* zones.
@ -682,7 +682,7 @@ private:
* failure code upon return.
* @param useLastResortData determine if use last resort data
*/
void initializeData(const Locale&, const char *type, UErrorCode& status, UBool useLastResortData = FALSE);
void initializeData(const Locale& locale, const char *type, UErrorCode& status, UBool useLastResortData = FALSE);
/**
* Copy or alias an array in another object, as appropriate.

6
icu4c/source/i18n/unicode/dtitvfmt.h
View file

@ -607,7 +607,7 @@ private:
* Caller should not delete them.
*
* @param locale the locale of this date interval formatter.
* @param dtitvinf the DateIntervalInfo object to be adopted.
* @param dtItvInfo the DateIntervalInfo object to be adopted.
* @param skeleton the skeleton of the date formatter
* @param status output param set to success/failure code on exit
* @internal ICU 4.0
@ -854,7 +854,7 @@ private:
*
* @param inputSkeleton the input skeleton
* @param bestMatchSkeleton the best match skeleton
* @param bestMatchIntervalpattern the best match interval pattern
* @param bestMatchIntervalPattern the best match interval pattern
* @param differenceInfo the difference between 2 skeletons
* 1 means only field width differs
* 2 means v/z exchange
@ -941,7 +941,7 @@ private:
*/
void setPatternInfo(UCalendarDateFields field,
const UnicodeString* firstPart,
const UnicodeString* secondpart,
const UnicodeString* secondPart,
UBool laterDateFirst);

10
icu4c/source/i18n/unicode/gregocal.h
View file

@ -1,5 +1,5 @@
/*
* Copyright (C) 1997-2009, International Business Machines Corporation and others.
* Copyright (C) 1997-2011, International Business Machines Corporation and others.
* All Rights Reserved.
********************************************************************************
*
@ -472,14 +472,6 @@ public:
*/
virtual const char * getType() const;
protected:
/**
* (Overrides Calendar) Converts GMT as milliseconds to time field values.
* @param status Fill-in parameter which receives the status of this operation.
* @stable ICU 2.0
*/
private:
GregorianCalendar(); // default constructor not implemented

4
icu4c/source/i18n/unicode/locdspnm.h
View file

@ -1,6 +1,6 @@
/*
******************************************************************************
* Copyright (C) 2010, International Business Machines Corporation and *
* Copyright (C) 2010-2011, International Business Machines Corporation and *
* others. All Rights Reserved. *
******************************************************************************
*/
@ -63,7 +63,7 @@ public:
// getters for state
/**
* Returns the locale used to determine the display names. This is
* not necessarily the same locale passed to {@link #getInstance}.
* not necessarily the same locale passed to {@link #createInstance}.
* @return the display locale
* @stable ICU 4.4
*/

11
icu4c/source/i18n/unicode/msgfmt.h
View file

@ -133,7 +133,7 @@ class NumberFormat;
* <li>Quotable syntax characters are the {curly braces} in all messageText parts,
* plus the '#' sign in a messageText immediately inside a pluralStyle,
* and the '|' symbol in a messageText immediately inside a choiceStyle.
* <li>See also {@link MessagePattern.ApostropheMode}
* <li>See also {@link #UMessagePatternApostropheMode}
* <li>In argStyleText, every single ASCII apostrophe begins and ends quoted literal text,
* and unquoted {curly braces} must occur in matched pairs.
* </ul>
@ -557,7 +557,7 @@ public:
/**
* Gets subformat pointer for given format name.
* This function supports both named and numbered
* arguments-- if numbered, the formatName is the
* arguments. If numbered, the formatName is the
* corresponding UnicodeStrings (e.g. "0", "1", "2"...).
* The returned Format object should not be deleted by the caller,
* nor should the ponter of other object . The pointer and its
@ -1051,8 +1051,11 @@ private:
*/
void resetPattern();
// A DummyFormatter that we use solely to store a NULL value. UHash does
// not support storing NULL values.
/**
* A DummyFormatter that we use solely to store a NULL value. UHash does
* not support storing NULL values.
* @internal
*/
class U_I18N_API DummyFormat : public Format {
public:
virtual UBool operator==(const Format&) const;

6
icu4c/source/i18n/unicode/plurfmt.h
View file

@ -481,6 +481,9 @@ public:
private:
/**
* @internal
*/
class PluralSelector {
public:
/**
@ -493,6 +496,9 @@ public:
virtual UnicodeString select(double number, UErrorCode& ec) const = 0;
};
/**
* @internal
*/
class PluralSelectorAdapter : public PluralSelector {
public:
PluralSelectorAdapter() : pluralRules(NULL) {

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

@ -30,7 +30,7 @@
/**
* Value returned by PluralRules::getUniqueKeywordValue() when there is no
* unique value to return.
* draft ICU 4.8
* @draft ICU 4.8
*/
#define UPLRULES_NO_UNIQUE_VALUE ((double)-0.00123456777)

1
icu4c/source/i18n/unicode/selfmt.h
View file

@ -169,6 +169,7 @@ class MessageFormat;
* delete msgFmt;
*
* \endhtmlonly
* </pre>
* </p>
*
* Produces the output:<br>

4
icu4c/source/i18n/unicode/simpletz.h
View file

@ -1,6 +1,6 @@
/*
********************************************************************************
* Copyright (C) 1997-2009, International Business Machines *
* Copyright (C) 1997-2011, International Business Machines *
* Corporation and others. All Rights Reserved. *
********************************************************************************
*
@ -807,7 +807,7 @@ private:
* @param endTime the time DST ends
* @param endTimeMode Whether the end time is local wall time, local
* standard time, or UTC time. Default is local wall time.
* @param savingsDST The number of milliseconds added to standard time
* @param dstSavings The number of milliseconds added to standard time
* to get DST time. Default is one hour.
* @param status An UErrorCode to receive the status.
*/

6
icu4c/source/i18n/unicode/smpdtfmt.h
View file

@ -811,6 +811,7 @@ private:
* "yyyy" in the pattern would result in a call to this function
* with ch equal to 'y' and count equal to 4)
* @param handler Records information about field positions.
* @param cal Calendar to use
* @param status Receives a status code, which will be U_ZERO_ERROR if the operation
* succeeds.
*/
@ -827,6 +828,7 @@ private:
* having a number of digits between "minDigits" and
* "maxDigits". Uses the DateFormat's NumberFormat.
*
* @param currentNumberFormat
* @param appendTo Output parameter to receive result.
* Formatted number is appended to existing contents.
* @param value Value to format.
@ -877,7 +879,7 @@ private:
* Called by construct() and the various constructors to set up the SimpleDateFormat's
* Calendar and NumberFormat objects.
* @param locale The locale for which we want a Calendar and a NumberFormat.
* @param statuc Filled in with an error code if creating either subobject fails.
* @param status Filled in with an error code if creating either subobject fails.
*/
void initialize(const Locale& locale, UErrorCode& status);
@ -935,10 +937,12 @@ private:
* @param ch the pattern character for the date field text to be parsed.
* @param count the count of a pattern character.
* @param obeyCount if true then the count is strictly obeyed.
* @param allowNegative
* @param ambiguousYear If true then the two-digit year == the default start year.
* @param saveHebrewMonth Used to hang onto month until year is known.
* @param cal a Calendar set to the date and time to be formatted
* into a date/time string.
* @param patLoc
* @return the new start position if matching succeeded; a negative number
* indicating matching failure, otherwise.
*/

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

@ -688,6 +688,7 @@ public:
* @param reorderCodes An array of script codes in the new order. This can be NULL if the
* length is also set to 0. An empty array will clear any reordering codes on the collator.
* @param reorderCodesLength The length of reorderCodes.
* @param status error code
* @see Collator#getReorderCodes
* @see Collator#getEquivalentReorderCodes
* @draft ICU 4.8
@ -854,7 +855,6 @@ private:
* Hence the responsibility of cleaning up the ucollator is not done by
* this RuleBasedCollator. The isDataOwned flag is set to FALSE.
* @param collator new ucollator data
* @param rules corresponding collation rules
*/
void setUCollator(UCollator *collator);

4
icu4c/source/i18n/unicode/timezone.h
View file

@ -778,7 +778,7 @@ private:
* @return Returns TRUE when the given custom id is valid.
*/
static UBool parseCustomID(const UnicodeString& id, int32_t& sign, int32_t& hour,
int32_t& min, int32_t& sec);
int32_t& minute, int32_t& second);
/**
* Parse a custom time zone identifier and return the normalized
@ -798,7 +798,7 @@ private:
* @param hour offset hours
* @param min offset minutes
* @param sec offset seconds
* @param netative sign of the offset, TRUE for negative offset.
* @param negative sign of the offset, TRUE for negative offset.
* @param id Receves the format result (normalized custom ID)
* @return The reference to id
*/

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

@ -46,7 +46,7 @@ enum UTimeUnitFormatStyle {
/** @draft ICU 4.8 */
UTMUTFMT_FORMAT_STYLE_COUNT
};
typedef enum UTimeUnitFormatStyle UTimeUnitFormatStyle;
typedef enum UTimeUnitFormatStyle UTimeUnitFormatStyle; /**< @draft ICU 4.8 */
U_NAMESPACE_BEGIN

4
icu4c/source/i18n/unicode/translit.h
View file

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (C) 1999-2008, International Business Machines
* Copyright (C) 1999-2011, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* Date Name Description
@ -652,7 +652,7 @@ private:
*
* <p>If this transliterator has a filter, break up the input text into runs
* of unfiltered characters. Pass each run to
* <subclass>.handleTransliterate().
* subclass.handleTransliterate().
*
* <p>In incremental mode, if rollback is TRUE, perform a special
* incremental procedure in which several passes are made over the input

5
icu4c/source/i18n/unicode/unum.h
View file

@ -252,12 +252,13 @@ typedef enum UNumberFormatPadPosition {
* Constants for specifying currency spacing
* @draft ICU 4.8
*/
typedef enum UCurrencySpacing {
enum UCurrencySpacing {
UNUM_CURRENCY_MATCH,
UNUM_CURRENCY_SURROUNDING_MATCH,
UNUM_CURRENCY_INSERT,
UNUM_CURRENCY_SPACING_COUNT
} UCurrencySpacing;
};
typedef enum UCurrencySpacing UCurrencySpacing; /**< @draft ICU 4.8 */
/**
* Create and return a new UNumberFormat for formatting and parsing

15
icu4c/source/io/unicode/ustream.h
View file

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (C) 2001-2010 International Business Machines
* Copyright (C) 2001-2011 International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* FILE NAME : ustream.h
@ -59,8 +59,21 @@ U_NAMESPACE_END
#include <iostream.h>
U_NAMESPACE_BEGIN
/**
* Write the contents of a UnicodeString to a C++ ostream. This functions writes
* the characters in a UnicodeString to an ostream. The UChars in the
* UnicodeString are converted to the char based ostream with the default
* converter.
* @stable 3.0
*/
U_IO_API ostream & U_EXPORT2 operator<<(ostream& stream, const UnicodeString& s);
/**
* Write the contents from a C++ istream to a UnicodeString. The UChars in the
* UnicodeString are converted from the char based istream with the default
* converter.
* @stable 3.0
*/
U_IO_API istream & U_EXPORT2 operator>>(istream& stream, UnicodeString& s);
U_NAMESPACE_END

4
icu4c/source/layout/LayoutEngine.h
View file

@ -63,9 +63,9 @@ class LEGlyphStorage;
*/
class U_LAYOUT_API LayoutEngine : public UObject {
public:
/** Flag to request kerning. */
/** @internal Flag to request kerning. */
static const le_int32 kTypoFlagKern;
/** Flag to request ligatures. */
/** @internal Flag to request ligatures. */
static const le_int32 kTypoFlagLiga;
protected: