organicmaps/icu
13
Fork 0
mirror of https://github.com/unicode-org/icu.git synced 2025-04-06 14:05:32 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions 9

ICU-9501 doxygen cleanup.

Browse source 
X-SVN-Rev: 32372
This commit is contained in:
Steven R. Loomis 2012-09-11 20:51:51 +00:00
parent 434a6ddb11
commit 1dff0b56ee
27 changed files with 139 additions and 64 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
icu4c/source/Doxyfile.in
View file

@ -86,7 +86,7 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = ./common/unicode/platform.h @srcdir@/common/unicode @srcdir@/i18n/unicode @srcdir@/io/unicode @srcdir@/layout/LEFontInstance.h @srcdir@/layout/LEGlyphStorage.h @srcdir@/layout/LELanguages.h @srcdir@/layout/LEScripts.h @srcdir@/layout/LESwaps.h @srcdir@/layout/LETypes.h @srcdir@/layout/LayoutEngine.h @srcdir@/layoutex/layout
INPUT = @srcdir@/common/unicode @srcdir@/i18n/unicode @srcdir@/io/unicode @srcdir@/layout/LEFontInstance.h @srcdir@/layout/LEGlyphStorage.h @srcdir@/layout/LELanguages.h @srcdir@/layout/LEScripts.h @srcdir@/layout/LESwaps.h @srcdir@/layout/LETypes.h @srcdir@/layout/LayoutEngine.h @srcdir@/layoutex/layout
FILE_PATTERNS = *.h
RECURSIVE = NO
EXCLUDE = @srcdir@/common/unicode/urename.h @srcdir@/common/unicode/udraft.h @srcdir@/common/unicode/udeprctd.h @srcdir@/common/unicode/uobslete.h @srcdir@/common/unicode/ppalmos.h
@ -192,7 +192,7 @@ EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED = U_EXPORT2= U_STABLE= U_DRAFT= U_INTERNAL= U_SYSTEM= U_DEPRECATED= U_OBSOLETE= U_CALLCONV= U_CDECL_BEGIN= U_CDECL_END= U_NO_THROW=\ "U_NAMESPACE_BEGIN=namespace icu{" "U_NAMESPACE_END=}" U_HAVE_STD_STRING= U_SHOW_CPLUSPLUS_API=1 U_DEFINE_LOCAL_OPEN_POINTER()=
PREDEFINED = U_EXPORT2= U_STABLE= U_DRAFT= U_INTERNAL= U_SYSTEM= U_DEPRECATED= U_OBSOLETE= U_CALLCONV= U_CDECL_BEGIN= U_CDECL_END= U_NO_THROW=\ "U_NAMESPACE_BEGIN=namespace icu{" "U_NAMESPACE_END=}" U_HAVE_STD_STRING=1 U_SHOW_CPLUSPLUS_API=1 U_DEFINE_LOCAL_OPEN_POINTER()= U_IN_DOXYGEN=1
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------

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

@ -12,6 +12,11 @@
* created by: Markus W. Scherer
*/
/**
* \file
* \brief C++ API: Builder for icu::BytesTrie
*/
#ifndef __BYTESTRIEBUILDER_H__
#define __BYTESTRIEBUILDER_H__

6
icu4c/source/common/unicode/docmain.h
View file

@ -9,7 +9,11 @@
* 12/11/2000 Ram Creation.
*/
/* This file contains documentation for Doxygen and doesnot have
/**
* \file
* \brief (Non API- contains Doxygen definitions)
*
* This file contains documentation for Doxygen and doesnot have
* any significance with respect to C or C++ API
*/

6
icu4c/source/common/unicode/icudataver.h
View file

@ -7,6 +7,12 @@
******************************************************************************
*/
/**
* \file
* \brief C API: access to ICU Data Version number
*/
#ifndef __ICU_DATA_VER_H__
#define __ICU_DATA_VER_H__

6
icu4c/source/common/unicode/localpointer.h
View file

@ -1,7 +1,7 @@
/*
*******************************************************************************
*
* Copyright (C) 2009-2010, International Business Machines
* Copyright (C) 2009-2012, International Business Machines
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
@ -144,6 +144,10 @@ public:
ptr=p;
}
protected:
/**
* Actual pointer.
* @internal
*/
T *ptr;
private:
// No comparison operators with other LocalPointerBases.

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

@ -41,6 +41,8 @@
* \brief C++ API: Locale ID object.
*/
U_NAMESPACE_BEGIN
/**
* A <code>Locale</code> object represents a specific geographical, political,
* or cultural region. An operation that requires a <code>Locale</code> 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 */

15
icu4c/source/common/unicode/platform.h
View file

@ -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 <code>#define</code> 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 @@
* <code>-x c++</code> 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.

7
icu4c/source/common/unicode/ptypes.h
View file

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

29
icu4c/source/common/unicode/stringtriebuilder.h
View file

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

5
icu4c/source/common/unicode/ucharstriebuilder.h
View file

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

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

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

5
icu4c/source/common/unicode/uidna.h
View file

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

5
icu4c/source/common/unicode/unistr.h
View file

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

10
icu4c/source/common/unicode/unorm2.h
View file

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

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

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

9
icu4c/source/common/unicode/ustring.h
View file

@ -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);
* }
* </pre>
*
* 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 <code>#define</code>.
* The following will not work on all platforms, don't use it.
*
* <pre>

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

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

49
icu4c/source/common/unicode/uvernum.h
View file

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

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

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

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

@ -40,7 +40,7 @@
#include "unicode/curramt.h"
/**
* \def UNUM_DECIMFORMAT_INTERNAL_SIZE
* \def UNUM_DECIMALFORMAT_INTERNAL_SIZE
* @internal
*/
#if UCONFIG_FORMAT_FASTPATHS_49

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

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

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

@ -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:
* <li>GMT zero format (e.g. "GMT" - see {@link #getGMTZeroFormat})
* </ul>
* @param offset the offset from GMT(UTC) in milliseconds.
* @param status Receives the status
* @param result Receives the localized GMT format string.
* @return A reference to the result.
* @see #parseOffsetLocalizedGMT

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

@ -319,7 +319,6 @@ public:
/**
* Returns the match length of a match at the specified index.
* @param idx The index
* @param status Receives the status
* @return The match length. If the specified idx is out of range,
* it returns 0.
* @internal ICU 49 technology preview
@ -339,7 +338,6 @@ public:
* Gets the metazone ID of a match at the specified index.
* @param idx The index
* @param mzID Receives the metazone ID
* @param status Receives the status.
* @return TRUE if the meta zone ID was set to mzID.
* @internal ICU 49 technology preview
*/

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

@ -122,7 +122,7 @@
* <p>
* 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.
*
* <p>

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

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

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

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

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

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