organicmaps/icu
13
Fork 0
mirror of https://github.com/unicode-org/icu.git synced 2025-04-05 21:45:37 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions 12

ICU-6552 reduce a lot of doxygen errs, improve output docs

Browse source 
X-SVN-Rev: 24668
This commit is contained in:
Steven R. Loomis 2008-09-27 01:12:32 +00:00
parent b88911b137
commit 0e7646b347
15 changed files with 102 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
icu4c/source/Doxyfile.in
View file

@ -27,7 +27,7 @@ JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
DISTRIBUTE_GROUP_DOC = NO
DISTRIBUTE_GROUP_DOC = YES
TAB_SIZE = 8
ALIASES = "memo=\par Note:\n" \
"draft=\xrefitem draft \"Draft\" \"Draft List\" This API may be changed in the future versions and was introduced in" \

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

@ -1,6 +1,6 @@
/********************************************************************
* COPYRIGHT:
* Copyright (c) 1997-2007, International Business Machines Corporation and
* Copyright (c) 1997-2008, International Business Machines Corporation and
* others. All Rights Reserved.
*
* FILE NAME: DOCMAIN.h
@ -199,4 +199,5 @@
* <td>ustream.h</td>
* </tr>
* </table>
* <i>This main page is generated from docmain.h</i>
*/

55
icu4c/source/common/unicode/platform.h.in
View file

@ -24,22 +24,26 @@
* \brief Basic types for the platform
*/
/* Define the platform we're on. */
/**
* \def @platform@
* Define the platform we're on. */
#ifndef @platform@
#define @platform@
#endif
/* Define whether dirent.h is available */
/**
* \def U_HAVE_DIRENT_H
* Define whether dirent.h is available */
#ifndef U_HAVE_DIRENT_H
#define U_HAVE_DIRENT_H @U_HAVE_DIRENT_H@
#endif
/* Define whether inttypes.h is available */
/** Define whether inttypes.h is available */
#ifndef U_HAVE_INTTYPES_H
#define U_HAVE_INTTYPES_H @U_HAVE_INTTYPES_H@
#endif
/*
/**
* Define what support for C++ streams is available.
* If U_IOSTREAM_SOURCE is set to 199711, then <iostream> is available
* (1997711 is the date the ISO/IEC C++ FDIS was published), and then
@ -57,7 +61,7 @@
#define U_IOSTREAM_SOURCE @U_IOSTREAM_SOURCE@
#endif
/* Determines whether specific types are available */
/** @{ Determines whether specific types are available */
#ifndef U_HAVE_INT8_T
#define U_HAVE_INT8_T @HAVE_INT8_T@
#endif
@ -90,8 +94,10 @@
#define U_HAVE_UINT64_T @HAVE_UINT64_T@
#endif
/** @} */
/*===========================================================================*/
/* Generic data types */
/** @{ Generic data types */
/*===========================================================================*/
#include <sys/types.h>
@ -156,8 +162,10 @@ typedef unsigned int uint32_t;
#endif
/** @} */
/*===========================================================================*/
/* Compiler and environment features */
/** @{ Compiler and environment features */
/*===========================================================================*/
/* Define whether namespace is supported */
@ -220,16 +228,20 @@ typedef unsigned int uint32_t;
#define U_LIB_SUFFIX_C_NAME @ICULIBSUFFIXCNAME@
#define U_LIB_SUFFIX_C_NAME_STRING "@ICULIBSUFFIXCNAME@"
/** @} */
/*===========================================================================*/
/* Character data types */
/** @{ Character data types */
/*===========================================================================*/
#if ((defined(OS390) && (!defined(__CHARSET_LIB) || !__CHARSET_LIB))) || defined(OS400)
# define U_CHARSET_FAMILY 1
#endif
/** @} */
/*===========================================================================*/
/* Information about wchar support */
/** @{ Information about wchar support */
/*===========================================================================*/
#ifndef U_HAVE_WCHAR_H
@ -244,7 +256,10 @@ typedef unsigned int uint32_t;
#define U_HAVE_WCSCPY @U_HAVE_WCSCPY@
#endif
/** @} */
/**
* @{
* \def U_DECLARE_UTF16
* Do not use this macro. Use the UNICODE_STRING or U_STRING_DECL macros
* instead.
@ -265,8 +280,10 @@ typedef unsigned int uint32_t;
#endif
#endif
/** @} */
/*===========================================================================*/
/* Information about POSIX support */
/** @{ Information about POSIX support */
/*===========================================================================*/
#ifndef U_HAVE_NL_LANGINFO_CODESET
@ -290,8 +307,10 @@ typedef unsigned int uint32_t;
#define U_HAVE_MMAP @HAVE_MMAP@
#define U_HAVE_POPEN @U_HAVE_POPEN@
/** @} */
/*===========================================================================*/
/* Symbol import-export control */
/** @{ Symbol import-export control */
/*===========================================================================*/
#if @U_USE_GCC_VISIBILITY_ATTRIBUTE@
@ -315,8 +334,10 @@ typedef unsigned int uint32_t;
#define U_IMPORT
#endif
/* @} */
/*===========================================================================*/
/* Code alignment and C function inlining */
/** @{ Code alignment and C function inlining */
/*===========================================================================*/
#ifndef U_INLINE
@ -331,12 +352,20 @@ typedef unsigned int uint32_t;
#define U_ALIGN_CODE(n)
#endif
/** @} */
/*===========================================================================*/
/* Programs used by ICU code */
/** @{ Programs used by ICU code */
/*===========================================================================*/
/**
* \def U_MAKE
* What program to execute to run 'make'
*/
#ifndef U_MAKE
#define U_MAKE "@U_MAKE@"
#endif
/** @} */
#endif

11
icu4c/source/common/unicode/putil.h
View file

@ -30,7 +30,7 @@
* \brief C API: Platform Utilities
*/
/* Define this to 1 if your platform supports IEEE 754 floating point,
/** Define this to 1 if your platform supports IEEE 754 floating point,
to 0 if it does not. */
#ifndef IEEE_754
# define IEEE_754 1
@ -58,7 +58,11 @@
* If u_setDataDirectory() has been called, that is it, otherwise
* if the ICU_DATA environment variable is set, use that, otherwise
* If a data directory was specifed at ICU build time
* <code>( #define ICU_DATA_DIR "path" )</code>, use that,
* <code>
* \code
* #define ICU_DATA_DIR "path"
* \endcode
* </code> use that,
* otherwise no data directory is available.
*
* @return the data directory, or an empty string ("") if no data directory has
@ -111,6 +115,7 @@ U_INTERNAL const char* U_EXPORT2 uprv_getDefaultCodepage(void);
U_INTERNAL const char* U_EXPORT2 uprv_getDefaultLocaleID(void);
/**
* @{
* Filesystem file and path separator characters.
* Example: '/' and ':' on Unix, '\\' and ';' on Windows.
* @stable ICU 2.0
@ -138,6 +143,8 @@ U_INTERNAL const char* U_EXPORT2 uprv_getDefaultLocaleID(void);
# define U_PATH_SEP_STRING ":"
#endif
/** @} */
/**
* Convert char characters to UChar characters.
* This utility function is useful only for "invariant characters"

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

@ -37,11 +37,12 @@
/**
* @{
* The selector data structure
*/
struct UConverterSelector;
typedef struct UConverterSelector UConverterSelector;
/** @} */
/**
* open a selector. If converterList is NULL, build for all converters. If excludedCodePoints
@ -57,7 +58,7 @@ typedef struct UConverterSelector UConverterSelector;
* the array.
* @param excludedCodePoints a set of codepoints to be excluded from
* consideration. set to NULL to exclude nothing
* @param whichset what converter set to use? use this to determine whether
* @param whichSet what converter set to use? use this to determine whether
* to construct selector for fallback or for roundtrip only mappings
* @param status an in/out ICU UErrorCode
* @return a pointer to the created selector
@ -142,7 +143,7 @@ U_CAPI int32_t ucnvsel_serialize(const UConverterSelector* sel,
*
* @draft ICU 4.2
*/
U_CAPI UEnumeration *ucnvsel_selectForString(const UConverterSelector*, const UChar *s,
U_CAPI UEnumeration *ucnvsel_selectForString(const UConverterSelector* sel, const UChar *s,
int32_t length, UErrorCode *status);
/**
@ -162,7 +163,7 @@ int32_t length, UErrorCode *status);
*
* @draft ICU 4.2
*/
U_CAPI UEnumeration *ucnvsel_selectForUTF8(const UConverterSelector*,
U_CAPI UEnumeration *ucnvsel_selectForUTF8(const UConverterSelector* sel,
const char *s,
int32_t length,
UErrorCode *status);

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

@ -113,10 +113,15 @@
#endif
/** This is used to declare a function as a public ICU C API @stable ICU 2.0*/
#define U_CAPI U_CFUNC U_EXPORT
/** This is used to declare a function as a stable public ICU C API*/
#define U_STABLE U_CAPI
/** This is used to declare a function as a draft public ICU C API */
#define U_DRAFT U_CAPI
/** This is used to declare a function as a deprecated public ICU C API */
#define U_DEPRECATED U_CAPI U_ATTRIBUTE_DEPRECATED
/** This is used to declare a function as an obsolete public ICU C API */
#define U_OBSOLETE U_CAPI
/** This is used to declare a function as an internal ICU C API */
#define U_INTERNAL U_CAPI
/*==========================================================================*/
@ -334,6 +339,11 @@ typedef int32_t UChar32;
#endif /* U_HIDE_INTERNAL_API */
/**
* \def U_INLINE
* This is used to request inlining of a function, on platforms and languages which support it.
*/
#ifndef U_INLINE
# ifdef XP_CPLUSPLUS
# define U_INLINE inline

18
icu4c/source/common/unicode/utf_old.h
View file

@ -1,7 +1,7 @@
/*
*******************************************************************************
*
* Copyright (C) 2002-2005, International Business Machines
* Copyright (C) 2002-2008, International Business Machines
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
@ -182,16 +182,18 @@ typedef int32_t UTextOffset;
#undef UTF_STRICT
/**
* <p>UTF8_ERROR_VALUE_1 and UTF8_ERROR_VALUE_2 are special error values for UTF-8,
* which need 1 or 2 bytes in UTF-8:<br>
* U+0015 = NAK = Negative Acknowledge, C0 control character<br>
* U+009f = highest C1 control character</p>
* UTF8_ERROR_VALUE_1 and UTF8_ERROR_VALUE_2 are special error values for UTF-8,
* which need 1 or 2 bytes in UTF-8:
* \code
* U+0015 = NAK = Negative Acknowledge, C0 control character
* U+009f = highest C1 control character
* \endcode
*
* <p>These are used by UTF8_..._SAFE macros so that they can return an error value
* These are used by UTF8_..._SAFE macros so that they can return an error value
* that needs the same number of code units (bytes) as were seen by
* a macro. They should be tested with UTF_IS_ERROR() or UTF_IS_VALID().</p>
* a macro. They should be tested with UTF_IS_ERROR() or UTF_IS_VALID().
*
* @deprecated ICU 2.4. Obsolete, see utf_old.h.
* @deprecated ICU W.4. Obsolete, see utf_old.h.
*/
#define UTF8_ERROR_VALUE_1 0x15

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

@ -38,6 +38,10 @@
#include "unicode/uversion.h"
#include "unicode/uconfig.h"
/**
* \def U_HIDE_DRAFT_API
* Define this to 1 to request that draft API be "hidden"
*/
#if !U_DEFAULT_SHOW_DRAFT && !defined(U_SHOW_DRAFT_API)
#define U_HIDE_DRAFT_API 1
#endif

3
icu4c/source/i18n/calendar.cpp
View file

@ -1234,9 +1234,6 @@ void Calendar::computeGregorianAndDOWFields(int32_t julianDay, UErrorCode &ec)
* variables gregorianXxx. They are used for time zone computations and by
* subclasses that are Gregorian derivatives. Subclasses may call this
* method to perform a Gregorian calendar millis->fields computation.
* To perform a Gregorian calendar fields->millis computation, call
* computeGregorianMonthStart().
* @see #computeGregorianMonthStart
*/
void Calendar::computeGregorianFields(int32_t julianDay, UErrorCode & /* ec */) {
int32_t gregorianDayOfWeekUnused;

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

@ -1718,17 +1718,17 @@ protected:
* @param eyear The extended year
* @internal
*/
virtual int32_t getDefaultMonthInYear(int32_t /*eyear*/) ;
virtual int32_t getDefaultMonthInYear(int32_t eyear) ;
/**
* Called by computeJulianDay. Returns the default day (1-based) for the month,
* taking currently-set year and era into account. Defaults to 1 for Gregorian.
* @param eyear the extended year
* @param mon the month in the year
* @param month the month in the year
* @internal
*/
virtual int32_t getDefaultDayInMonth(int32_t /*eyear*/, int32_t /*month*/);
virtual int32_t getDefaultDayInMonth(int32_t eyear, int32_t month);
//-------------------------------------------------------------------------
// Protected utility methods for use by subclasses. These are very handy
@ -1953,9 +1953,6 @@ private:
* variables gregorianXxx. They are used for time zone computations and by
* subclasses that are Gregorian derivatives. Subclasses may call this
* method to perform a Gregorian calendar millis->fields computation.
* To perform a Gregorian calendar fields->millis computation, call
* computeGregorianMonthStart().
* @see #computeGregorianMonthStart
*/
void computeGregorianFields(int32_t julianDay, UErrorCode &ec);

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

@ -916,8 +916,9 @@ protected:
/**
* Used internally by registraton to define the requested and valid locales.
* @param requestedLocale the requsted locale
* @param requestedLocale the requested locale
* @param validLocale the valid locale
* @param actualLocale the actual locale
* @internal
*/
virtual void setLocales(const Locale& requestedLocale, const Locale& validLocale, const Locale& actualLocale);

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

@ -326,9 +326,9 @@ public:
*
* @param number a number for which the plural message should be formatted
* for. If no pattern has been applied to this
* <code>PluralFormat</code> object yet, the formatted number
* PluralFormat object yet, the formatted number
* will be returned.
* @param status output param set to success/failure code on exit, which
* @param status output param set to success or failure code on exit, which
* must not indicate a failure before the function call.
* @return the string containing the formatted plural message.
* @draft ICU 4.0
@ -383,7 +383,7 @@ public:
* i.e., a pattern that was applied previously will be removed,
* and the NumberFormat is set to the default number format for
* the locale. The resulting format behaves the same as one
* constructed from {@link #PluralFormat(locale)}.
* constructed from {@link #PluralFormat(const Locale& locale, UErrorCode& status)}.
* @param locale the <code>locale</code> to use to configure the formatter.
* @param status output param set to success/failure code on exit, which
* must not indicate a failure before the function call.

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

@ -66,6 +66,7 @@ class RuleParser;
* </p>
* <p>
* Syntax:<pre>
* \code
* rules = rule (';' rule)*
* rule = keyword ':' condition
* keyword = <identifier>
@ -79,6 +80,7 @@ class RuleParser;
* value = digit+
* digit = 0|1|2|3|4|5|6|7|8|9
* range = value'..'value
* \endcode
* </pre></p>
* <p>
* The difference between 'in' and 'within' is that 'in' only includes

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

@ -173,6 +173,7 @@ typedef enum UDateFormatStyle {
/**
* @{
* Below are a set of pre-defined skeletons.
*
* <P>
@ -210,7 +211,11 @@ typedef enum UDateFormatStyle {
#define UDAT_ABBR_STANDALONE_MONTH "LLL"
#define UDAT_YEAR_QUARTER "yQQQ"
#define UDAT_YEAR_ABBR_QUARTER "yQ"
/** @} */
/**
* @{
* Below are a set of pre-defined skeletons that
* have pre-defined interval patterns in resource files.
* Users are encouraged to use them in date interval format factory methods.
@ -243,6 +248,8 @@ typedef enum UDateFormatStyle {
#define UDAT_HOUR_GENERIC_TZ "hv"
#define UDAT_HOUR_TZ "hz"
/** @} */
/**
* FieldPosition and UFieldPosition selectors for format fields

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

@ -68,7 +68,7 @@ typedef enum URegexpFlag{
* on matching when used in conjunction with this flag.
* The other flags become superfluous.
* TODO: say which escapes are still handled; anything Java does
* early (\u) we should still do.
* early (\\u) we should still do.
* @draft ICU 4.0
*/
UREGEX_LITERAL = 16,
@ -80,7 +80,7 @@ typedef enum URegexpFlag{
UREGEX_MULTILINE = 8,
/** Unix-only line endings.
* When this mode is enabled, only \u000a is recognized as a line ending
* When this mode is enabled, only \\u000a is recognized as a line ending
* in the behavior of ., ^, and $.
* @draft ICU 4.0
*/