Locale object represents a specific geographical, political,
* or cultural region. An operation that requires a Locale to perform
@@ -177,7 +179,6 @@
* @stable ICU 2.0
* @see ResourceBundle
*/
-U_NAMESPACE_BEGIN
class U_COMMON_API Locale : public UObject {
public:
/** Useful constant for the Root locale. @stable ICU 4.4 */
diff --git a/icu4c/source/common/unicode/platform.h b/icu4c/source/common/unicode/platform.h
index 28d301ef401..94769d63f9a 100644
--- a/icu4c/source/common/unicode/platform.h
+++ b/icu4c/source/common/unicode/platform.h
@@ -36,7 +36,7 @@
* and/or from other macros that are predefined by the compiler
* or defined in standard (POSIX or platform or compiler) headers.
*
- * As a temporary workaround, you can add an explicit #define for some macros
+ * As a temporary workaround, you can add an explicit #define for some macros
* before it is first tested, or add an equivalent -D macro definition
* to the compiler's command line.
*
@@ -50,6 +50,19 @@
* -x c++ is for C++.)
*/
+/**
+ * Define some things so that they can be documented.
+ * @internal
+ */
+#ifdef U_IN_DOXYGEN
+/*
+ * Problem: "platform.h:335: warning: documentation for unknown define U_HAVE_STD_STRING found." means that U_HAVE_STD_STRING is not documented.
+ * Solution: #define any defines for non @internal API here, so that they are visible in the docs. If you just set PREDEFINED in Doxyfile.in, they won't be documented.
+ */
+
+/* None for now. */
+#endif
+
/**
* \def U_PLATFORM
* The U_PLATFORM macro defines the platform we're on.
diff --git a/icu4c/source/common/unicode/ptypes.h b/icu4c/source/common/unicode/ptypes.h
index 46eb0fdaaf5..b7f71160328 100644
--- a/icu4c/source/common/unicode/ptypes.h
+++ b/icu4c/source/common/unicode/ptypes.h
@@ -1,7 +1,7 @@
/*
******************************************************************************
*
-* Copyright (C) 1997-2011, International Business Machines
+* Copyright (C) 1997-2012, International Business Machines
* Corporation and others. All Rights Reserved.
*
******************************************************************************
@@ -17,6 +17,11 @@
******************************************************************************
*/
+/**
+ * \file
+ * \brief C API: Definitions of integer types of various widths
+ */
+
#ifndef _PTYPES_H
#define _PTYPES_H
diff --git a/icu4c/source/common/unicode/stringtriebuilder.h b/icu4c/source/common/unicode/stringtriebuilder.h
index b35ac4b08d4..9cb2ae5ef7e 100644
--- a/icu4c/source/common/unicode/stringtriebuilder.h
+++ b/icu4c/source/common/unicode/stringtriebuilder.h
@@ -18,6 +18,11 @@
#include "unicode/utypes.h"
#include "unicode/uobject.h"
+/**
+ * \file
+ * \brief C++ API: Builder API for trie builders
+ */
+
// Forward declaration.
struct UHashtable;
typedef struct UHashtable UHashtable;
@@ -255,7 +260,9 @@ protected:
int32_t value;
};
- /** @internal */
+ /**
+ * @internal
+ */
class ValueNode : public Node {
public:
ValueNode(int32_t initialHash) : Node(initialHash), hasValue(FALSE), value(0) {}
@@ -270,7 +277,9 @@ protected:
int32_t value;
};
- /** @internal */
+ /**
+ * @internal
+ */
class IntermediateValueNode : public ValueNode {
public:
IntermediateValueNode(int32_t v, Node *nextNode)
@@ -282,7 +291,9 @@ protected:
Node *next;
};
- /** @internal */
+ /**
+ * @internal
+ */
class LinearMatchNode : public ValueNode {
public:
LinearMatchNode(int32_t len, Node *nextNode)
@@ -295,7 +306,9 @@ protected:
Node *next;
};
- /** @internal */
+ /**
+ * @internal
+ */
class BranchNode : public Node {
public:
BranchNode(int32_t initialHash) : Node(initialHash) {}
@@ -303,7 +316,9 @@ protected:
int32_t firstEdgeNumber;
};
- /** @internal */
+ /**
+ * @internal
+ */
class ListBranchNode : public BranchNode {
public:
ListBranchNode() : BranchNode(0x444444), length(0) {}
@@ -333,7 +348,9 @@ protected:
UChar units[kMaxBranchLinearSubNodeLength];
};
- /** @internal */
+ /**
+ * @internal
+ */
class SplitBranchNode : public BranchNode {
public:
SplitBranchNode(UChar middleUnit, Node *lessThanNode, Node *greaterOrEqualNode)
diff --git a/icu4c/source/common/unicode/ucharstriebuilder.h b/icu4c/source/common/unicode/ucharstriebuilder.h
index cbdd9392d62..f1ffc4ce4b0 100644
--- a/icu4c/source/common/unicode/ucharstriebuilder.h
+++ b/icu4c/source/common/unicode/ucharstriebuilder.h
@@ -20,6 +20,11 @@
#include "unicode/ucharstrie.h"
#include "unicode/unistr.h"
+/**
+ * \file
+ * \brief C++ API: Builder for icu::UCharsTrie
+ */
+
U_NAMESPACE_BEGIN
class UCharsTrieElement;
diff --git a/icu4c/source/common/unicode/uconfig.h b/icu4c/source/common/unicode/uconfig.h
index 5482cb0bbae..878e346bb9e 100644
--- a/icu4c/source/common/unicode/uconfig.h
+++ b/icu4c/source/common/unicode/uconfig.h
@@ -410,7 +410,7 @@
/**
- * \def UCONFIG_HAVE_PARSEALLINPUT
+ * \def UCONFIG_FORMAT_FASTPATHS_49
* This switch turns on other formatting fastpaths. Binary incompatible in object DecimalFormat and DecimalFormatSymbols
*
* @internal
diff --git a/icu4c/source/common/unicode/uidna.h b/icu4c/source/common/unicode/uidna.h
index 9554eeab47b..e1f298b233b 100644
--- a/icu4c/source/common/unicode/uidna.h
+++ b/icu4c/source/common/unicode/uidna.h
@@ -174,7 +174,7 @@ U_NAMESPACE_END
* \endcode
* @stable ICU 4.6
*/
-struct UIDNAInfo {
+typedef struct UIDNAInfo {
/** sizeof(UIDNAInfo) @stable ICU 4.6 */
int16_t size;
/**
@@ -192,8 +192,7 @@ struct UIDNAInfo {
uint32_t errors;
int32_t reservedI2; /**< Reserved field, do not use. @internal */
int32_t reservedI3; /**< Reserved field, do not use. @internal */
-};
-typedef struct UIDNAInfo UIDNAInfo;
+} UIDNAInfo;
/**
* Static initializer for a UIDNAInfo struct.
diff --git a/icu4c/source/common/unicode/unistr.h b/icu4c/source/common/unicode/unistr.h
index 30dd39bd996..6c5d1f4edc9 100644
--- a/icu4c/source/common/unicode/unistr.h
+++ b/icu4c/source/common/unicode/unistr.h
@@ -54,6 +54,11 @@ U_STABLE int32_t U_EXPORT2
u_strlen(const UChar *s);
#endif
+/**
+ * \def U_STRING_CASE_MAPPER_DEFINED
+ * @internal
+ */
+
#ifndef U_STRING_CASE_MAPPER_DEFINED
#define U_STRING_CASE_MAPPER_DEFINED
diff --git a/icu4c/source/common/unicode/unorm2.h b/icu4c/source/common/unicode/unorm2.h
index 27f81915acc..1ff2cb7aa13 100644
--- a/icu4c/source/common/unicode/unorm2.h
+++ b/icu4c/source/common/unicode/unorm2.h
@@ -123,7 +123,7 @@ typedef struct UNormalizer2 UNormalizer2; /**< C typedef for struct UNormalizer
* Returns a UNormalizer2 instance for Unicode NFC normalization.
* Same as unorm2_getInstance(NULL, "nfc", UNORM2_COMPOSE, pErrorCode).
* Returns an unmodifiable singleton instance. Do not delete it.
- * @param errorCode Standard ICU error code. Its input value must
+ * @param pErrorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
@@ -137,7 +137,7 @@ unorm2_getNFCInstance(UErrorCode *pErrorCode);
* Returns a UNormalizer2 instance for Unicode NFD normalization.
* Same as unorm2_getInstance(NULL, "nfc", UNORM2_DECOMPOSE, pErrorCode).
* Returns an unmodifiable singleton instance. Do not delete it.
- * @param errorCode Standard ICU error code. Its input value must
+ * @param pErrorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
@@ -151,7 +151,7 @@ unorm2_getNFDInstance(UErrorCode *pErrorCode);
* Returns a UNormalizer2 instance for Unicode NFKC normalization.
* Same as unorm2_getInstance(NULL, "nfkc", UNORM2_COMPOSE, pErrorCode).
* Returns an unmodifiable singleton instance. Do not delete it.
- * @param errorCode Standard ICU error code. Its input value must
+ * @param pErrorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
@@ -165,7 +165,7 @@ unorm2_getNFKCInstance(UErrorCode *pErrorCode);
* Returns a UNormalizer2 instance for Unicode NFKD normalization.
* Same as unorm2_getInstance(NULL, "nfkc", UNORM2_DECOMPOSE, pErrorCode).
* Returns an unmodifiable singleton instance. Do not delete it.
- * @param errorCode Standard ICU error code. Its input value must
+ * @param pErrorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
@@ -179,7 +179,7 @@ unorm2_getNFKDInstance(UErrorCode *pErrorCode);
* Returns a UNormalizer2 instance for Unicode NFKC_Casefold normalization.
* Same as unorm2_getInstance(NULL, "nfkc_cf", UNORM2_COMPOSE, pErrorCode).
* Returns an unmodifiable singleton instance. Do not delete it.
- * @param errorCode Standard ICU error code. Its input value must
+ * @param pErrorCode Standard ICU error code. Its input value must
* pass the U_SUCCESS() test, or else the function returns
* immediately. Check for U_FAILURE() on output or use with
* function chaining. (See User Guide for details.)
diff --git a/icu4c/source/common/unicode/ures.h b/icu4c/source/common/unicode/ures.h
index 3238d488a0c..587e85d335c 100644
--- a/icu4c/source/common/unicode/ures.h
+++ b/icu4c/source/common/unicode/ures.h
@@ -1,6 +1,6 @@
/*
**********************************************************************
-* Copyright (C) 1997-2011, International Business Machines
+* Copyright (C) 1997-2012, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
*
@@ -831,7 +831,7 @@ ures_getNextUnicodeString(UResourceBundle *resB,
* Returns the string in a given resource at the specified index.
*
* @param resB a resource
- * @param index an index to the wanted string.
+ * @param indexS an index to the wanted string.
* @param status fills in the outgoing error code
* @return an UnicodeString object. If there is an error, string is bogus
* @stable ICU 2.0
diff --git a/icu4c/source/common/unicode/ustring.h b/icu4c/source/common/unicode/ustring.h
index d0b9188efcc..c5774315858 100644
--- a/icu4c/source/common/unicode/ustring.h
+++ b/icu4c/source/common/unicode/ustring.h
@@ -20,9 +20,14 @@
#include "unicode/putil.h"
#include "unicode/uiter.h"
-/** Simple declaration for u_strToTitle() to avoid including unicode/ubrk.h. @stable ICU 2.1*/
+/**
+ * \def UBRK_TYPEDEF_UBREAK_ITERATOR
+ * @internal
+ */
+
#ifndef UBRK_TYPEDEF_UBREAK_ITERATOR
# define UBRK_TYPEDEF_UBREAK_ITERATOR
+/** Simple declaration for u_strToTitle() to avoid including unicode/ubrk.h. @stable ICU 2.1*/
typedef struct UBreakIterator UBreakIterator;
#endif
@@ -918,7 +923,7 @@ u_memrchr32(const UChar *s, UChar32 c, int32_t count);
* }
*
*
- * Note that the macros will NOT consistently work if their argument is another #define.
+ * Note that the macros will NOT consistently work if their argument is another #define.
* The following will not work on all platforms, don't use it.
*
*
diff --git a/icu4c/source/common/unicode/utext.h b/icu4c/source/common/unicode/utext.h
index e5f0c8cfce1..d431913d35b 100644
--- a/icu4c/source/common/unicode/utext.h
+++ b/icu4c/source/common/unicode/utext.h
@@ -304,7 +304,7 @@ utext_openReplaceable(UText *ut, icu::Replaceable *rep, UErrorCode *status);
* @stable ICU 3.4
*/
U_STABLE UText * U_EXPORT2
-utext_openCharacterIterator(UText *ut, icu::CharacterIterator *ic, UErrorCode *status);
+utext_openCharacterIterator(UText *ut, icu::CharacterIterator *ci, UErrorCode *status);
#endif
diff --git a/icu4c/source/common/unicode/uvernum.h b/icu4c/source/common/unicode/uvernum.h
index 123573eaaaf..ad5a3c186f9 100644
--- a/icu4c/source/common/unicode/uvernum.h
+++ b/icu4c/source/common/unicode/uvernum.h
@@ -12,28 +12,37 @@
* Created by: Vladimir Weinstein
* Updated by: Steven R. Loomis
*
-* Gets included by uversion.h and other files.
-*
-* IMPORTANT: When updating version, the following things need to be done:
-* source/common/unicode/uvernum.h - this file: update major, minor,
-* patchlevel, suffix, version, short version constants, namespace,
-* renaming macro, and copyright
-*
-* The following files need to be updated as well, which can be done
-* by running the UNIX makefile target 'update-windows-makefiles' in icu/source.
-*
-*
-* source/common/common.vcproj - update 'Output file name' on the link tab so
-* that it contains the new major/minor combination
-* source/i18n/i18n.vcproj - same as for the common.vcproj
-* source/layout/layout.vcproj - same as for the common.vcproj
-* source/layoutex/layoutex.vcproj - same
-* source/stubdata/stubdata.vcproj - same as for the common.vcproj
-* source/io/io.vcproj - same as for the common.vcproj
-* source/data/makedata.mak - change U_ICUDATA_NAME so that it contains
-* the new major/minor combination and the Unicode version.
*/
+/**
+ * \file
+ * \brief C API: definitions of ICU version numbers
+ *
+ * This file is included by uversion.h and other files. This file contains only
+ * macros and definitions. The actual version numbers are defined here.
+ */
+
+ /*
+ * IMPORTANT: When updating version, the following things need to be done:
+ * source/common/unicode/uvernum.h - this file: update major, minor,
+ * patchlevel, suffix, version, short version constants, namespace,
+ * renaming macro, and copyright
+ *
+ * The following files need to be updated as well, which can be done
+ * by running the UNIX makefile target 'update-windows-makefiles' in icu/source.
+ *
+ *
+ * source/common/common.vcproj - update 'Output file name' on the link tab so
+ * that it contains the new major/minor combination
+ * source/i18n/i18n.vcproj - same as for the common.vcproj
+ * source/layout/layout.vcproj - same as for the common.vcproj
+ * source/layoutex/layoutex.vcproj - same
+ * source/stubdata/stubdata.vcproj - same as for the common.vcproj
+ * source/io/io.vcproj - same as for the common.vcproj
+ * source/data/makedata.mak - change U_ICUDATA_NAME so that it contains
+ * the new major/minor combination and the Unicode version.
+ */
+
#ifndef UVERNUM_H
#define UVERNUM_H
diff --git a/icu4c/source/i18n/unicode/coll.h b/icu4c/source/i18n/unicode/coll.h
index 5a5a4d4085f..ee5e9b09c1f 100644
--- a/icu4c/source/i18n/unicode/coll.h
+++ b/icu4c/source/i18n/unicode/coll.h
@@ -262,7 +262,7 @@ public:
/**
* Returns true if "other" is not the same as "this".
- * Calls !Collator::operator==(other) which works for all subclasses.
+ * Calls ! operator==(const Collator&) const which works for all subclasses.
* @param other Collator object to be compared
* @return TRUE if other is not the same as this.
* @stable ICU 2.0
diff --git a/icu4c/source/i18n/unicode/decimfmt.h b/icu4c/source/i18n/unicode/decimfmt.h
index 4c44ce171d7..501e5beee64 100644
--- a/icu4c/source/i18n/unicode/decimfmt.h
+++ b/icu4c/source/i18n/unicode/decimfmt.h
@@ -40,7 +40,7 @@
#include "unicode/curramt.h"
/**
- * \def UNUM_DECIMFORMAT_INTERNAL_SIZE
+ * \def UNUM_DECIMALFORMAT_INTERNAL_SIZE
* @internal
*/
#if UCONFIG_FORMAT_FASTPATHS_49
diff --git a/icu4c/source/i18n/unicode/translit.h b/icu4c/source/i18n/unicode/translit.h
index f2a1d1bc7e6..eec3246025a 100644
--- a/icu4c/source/i18n/unicode/translit.h
+++ b/icu4c/source/i18n/unicode/translit.h
@@ -1,6 +1,6 @@
/*
**********************************************************************
-* Copyright (C) 1999-2011, International Business Machines
+* Copyright (C) 1999-2012, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* Date Name Description
@@ -497,8 +497,7 @@ public:
* for details.
* @param text the buffer holding transliterated and
* untransliterated text
- * @param index an array of three integers. See {@link
- * #transliterate(Replaceable&, UTransPosition&, const UnicodeString&, UErrorCode&) const }.
+ * @param index an array of three integers. See {@link #transliterate(Replaceable&, UTransPosition&, const UnicodeString*, UErrorCode&) const }.
* @param status Output param to filled in with a success or an error.
* @see #transliterate(Replaceable, int[], String)
* @stable ICU 2.0
diff --git a/icu4c/source/i18n/unicode/tzfmt.h b/icu4c/source/i18n/unicode/tzfmt.h
index d915850434b..e8fe31e528c 100644
--- a/icu4c/source/i18n/unicode/tzfmt.h
+++ b/icu4c/source/i18n/unicode/tzfmt.h
@@ -330,6 +330,7 @@ public:
* @param offset The offset from GMT(UTC) in milliseconds.
* @param result Recevies the RFC822 style GMT(UTC) offset format.
* @return A reference to the result.
+ * @param status Receives the status
* @see #parseOffsetRFC822
* @internal ICU 49 technology preview
*/
@@ -339,7 +340,8 @@ public:
* Returns the ISO 8601 style time zone string for the given offset.
* For example, "-08:00" and "Z".
* @param offset The offset from GMT(UTC) in milliseconds.
- * @param result Recevies the ISO 8601 style GMT(UTC) offset format.
+ * @param result Receives the ISO 8601 style GMT(UTC) offset format.
+ * @param status Receives the status
* @return A reference to the result.
* @see #parseOffsetISO8601
* @internal ICU 49 technology preview
@@ -356,6 +358,7 @@ public:
* * The date or time format strings are not part of the definition of a * calendar, as those must be modifiable or overridable by the user at - * runtime. Use {@link DateFormat} + * runtime. Use {@link icu::DateFormat} * to format dates. * *
diff --git a/icu4c/source/i18n/unicode/udatpg.h b/icu4c/source/i18n/unicode/udatpg.h index cea1d608a02..7e8ca472744 100644 --- a/icu4c/source/i18n/unicode/udatpg.h +++ b/icu4c/source/i18n/unicode/udatpg.h @@ -1,7 +1,7 @@ /* ******************************************************************************* * -* Copyright (C) 2007-2011, International Business Machines +* Copyright (C) 2007-2012, International Business Machines * Corporation and others. All Rights Reserved. * ******************************************************************************* @@ -23,7 +23,7 @@ /** * \file - * \brief C API: Wrapper for DateTimePatternGenerator (unicode/dtptngen.h). + * \brief C API: Wrapper for icu::DateTimePatternGenerator (unicode/dtptngen.h). * * UDateTimePatternGenerator provides flexible generation of date format patterns, * like "yy-MM-dd". The user can build up the generator by adding successive diff --git a/icu4c/source/i18n/unicode/uldnames.h b/icu4c/source/i18n/unicode/uldnames.h index 4a119ea2653..094be2b6e71 100644 --- a/icu4c/source/i18n/unicode/uldnames.h +++ b/icu4c/source/i18n/unicode/uldnames.h @@ -1,6 +1,6 @@ /* ******************************************************************************* -* Copyright (C) 2010, International Business Machines Corporation and * +* Copyright (C) 2010-2012, International Business Machines Corporation and * * others. All Rights Reserved. * ******************************************************************************* */ @@ -10,7 +10,7 @@ /** * \file - * \brief C++ API: Provides display names of Locale ids and their components. + * \brief C API: Provides display names of Locale ids and their components. */ #include "unicode/utypes.h" diff --git a/icu4c/source/i18n/unicode/uspoof.h b/icu4c/source/i18n/unicode/uspoof.h index e59d314c266..0a0c2ff37b8 100644 --- a/icu4c/source/i18n/unicode/uspoof.h +++ b/icu4c/source/i18n/unicode/uspoof.h @@ -599,7 +599,7 @@ uspoof_checkUTF8(const USpoofChecker *sc, * * @param sc The USpoofChecker * @param text A UnicodeString to be checked for possible security issues. - * @position An out parameter that receives the index of the + * @param position An out parameter that receives the index of the * first string position that fails the allowed character * limitation checks. * This parameter may be null if the position information @@ -838,9 +838,6 @@ uspoof_getSkeletonUTF8(const USpoofChecker *sc, * USPOOF_ANY_CASE_CONFUSABLE. The two flags may be ORed. * @param s The input string whose skeleton will be computed. * @param dest The output string, to receive the skeleton string. - * @param destCapacity The length of the output buffer, in bytes. - * The destCapacity may be zero, in which case the function will - * return the actual length of the skeleton. * @param status The error code, set if an error occurred while attempting to * perform the check. * @return A reference to the destination (skeleton) string.