AuroraMiddleware/scuffed-code
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ICU-4524 add brief documentation

Browse Source 
X-SVN-Rev: 17983
This commit is contained in:
Ram Viswanadha 2005-06-22 22:39:36 +00:00
parent 76f2060e2e
commit d0eb5dd8e9
72 changed files with 427 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
icu4c/source/common/unicode/brkiter.h
View File

@ -22,6 +22,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Break Iterator.
*/
#if UCONFIG_NO_BREAK_ITERATION
U_NAMESPACE_BEGIN

7
icu4c/source/common/unicode/caniter.h
View File

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 1996-2004, International Business Machines Corporation and *
* Copyright (C) 1996-2005, International Business Machines Corporation and *
* others. All Rights Reserved. *
*******************************************************************************
*/
@ -15,6 +15,11 @@
#include "unicode/uobject.h"
#include "unicode/unistr.h"
/**
* \file
* \brief C++ API: Canonical Iterator
*/
/** Should permutation skip characters with combining class zero
* Should be either TRUE or FALSE. This is a compile time option
* @stable ICU 2.4

8
icu4c/source/common/unicode/chariter.h
View File

@ -1,7 +1,7 @@
/*
********************************************************************
*
* Copyright (C) 1997-2004, International Business Machines
* Copyright (C) 1997-2005, International Business Machines
* Corporation and others. All Rights Reserved.
*
********************************************************************
@ -13,7 +13,11 @@
#include "unicode/utypes.h"
#include "unicode/uobject.h"
#include "unicode/unistr.h"
/**
* \file
* \brief C++ API: Character Iterator
*/
U_NAMESPACE_BEGIN
/**
* Abstract class that defines an API for forward-only iteration

7
icu4c/source/common/unicode/dbbi.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (C) 1999-2004 IBM Corp. All rights reserved.
* Copyright (C) 1999-2005 IBM Corp. All rights reserved.
**********************************************************************
* Date Name Description
* 12/1/99 rgillam Complete port from Java.
@ -15,6 +15,11 @@
#if !UCONFIG_NO_BREAK_ITERATION
/**
* \file
* \brief C++ API: Dictionary Based Break Iterator
*/
U_NAMESPACE_BEGIN
/* forward declaration */

9
icu4c/source/common/unicode/normlzr.h
View File

@ -1,7 +1,7 @@
/*
********************************************************************
* COPYRIGHT:
* Copyright (c) 1996-2004, International Business Machines Corporation and
* Copyright (c) 1996-2005, International Business Machines Corporation and
* others. All Rights Reserved.
********************************************************************
*/
@ -11,6 +11,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Unicode Normalization
*/
#if !UCONFIG_NO_NORMALIZATION
#include "unicode/uobject.h"
@ -18,12 +23,12 @@
#include "unicode/chariter.h"
#include "unicode/unorm.h"
struct UCharIterator;
typedef struct UCharIterator UCharIterator; /**< C typedef for struct UCharIterator. @stable ICU 2.1 */
U_NAMESPACE_BEGIN
/**
* \brief C++ API: Unicode Normalization
*
* The Normalizer class consists of two parts:
* - static functions that normalize strings or test if strings are normalized

6
icu4c/source/common/unicode/parseerr.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (C) 1999-2004, International Business Machines
* Copyright (C) 1999-2005, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* Date Name Description
@ -14,6 +14,10 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C API: Parse Error Information
*/
/**
* The capacity of the context strings in UParseError.
* @stable ICU 2.0

7
icu4c/source/common/unicode/parsepos.h
View File

@ -1,5 +1,5 @@
/*
* Copyright (C) 1997-2004, International Business Machines Corporation and others. All Rights Reserved.
* Copyright (C) 1997-2005, International Business Machines Corporation and others. All Rights Reserved.
*******************************************************************************
*
* File PARSEPOS.H
@ -19,9 +19,14 @@
#include "unicode/utypes.h"
#include "unicode/uobject.h"
U_NAMESPACE_BEGIN
/**
* \file
* \brief C++ API: Canonical Iterator
*/
/**
* <code>ParsePosition</code> is a simple class used by <code>Format</code>
* and its subclasses to keep track of the current position during parsing.
* The <code>parseObject</code> method in the various <code>Format</code>

5
icu4c/source/common/unicode/platform.h.in
View File

@ -16,6 +16,11 @@
******************************************************************************
*/
/**
* \file
* \brief Basic types for the platform
*/
/* Define the platform we're on. */
#ifndef @platform@
#define @platform@

6
icu4c/source/common/unicode/putil.h
View File

@ -25,7 +25,11 @@
#define PUTIL_H
#include "unicode/utypes.h"
/**
* \file
* \brief C API: Platform Utilities
*/
/* Define this to 1 if your platform supports IEEE 754 floating point,
to 0 if it does not. */
#ifndef IEEE_754

5
icu4c/source/common/unicode/pwin32.h
View File

@ -16,6 +16,11 @@
******************************************************************************
*/
/**
* \file
* \brief C API: Constants for Win32 platform
*/
/* Define the platform we're on. */
#ifndef U_WINDOWS
#define U_WINDOWS

7
icu4c/source/common/unicode/rbbi.h
View File

@ -16,12 +16,18 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Rule Based Break Iterator
*/
#if !UCONFIG_NO_BREAK_ITERATION
#include "unicode/brkiter.h"
#include "unicode/udata.h"
#include "unicode/parseerr.h"
struct UTrie;
U_NAMESPACE_BEGIN
@ -36,6 +42,7 @@ struct RBBIStateTable;
/**
*
* A subclass of BreakIterator whose behavior is specified using a list of rules.
* <p>Instances of this class are most commonly created by the factory methods of
* BreakIterator::createWordInstance(), BreakIterator::createLineInstance(), etc.,

7
icu4c/source/common/unicode/rep.h
View File

@ -1,6 +1,6 @@
/*
**************************************************************************
* Copyright (C) 1999-2004, International Business Machines Corporation and
* Copyright (C) 1999-2005, International Business Machines Corporation and
* others. All Rights Reserved.
**************************************************************************
* Date Name Description
@ -16,6 +16,11 @@
#include "unicode/uobject.h"
/**
* \file
* \brief C++ API: Replaceable String
*/
U_NAMESPACE_BEGIN
class UnicodeString;

5
icu4c/source/common/unicode/resbund.h
View File

@ -52,6 +52,11 @@
#include "unicode/unistr.h"
#include "unicode/locid.h"
/**
* \file
* \brief C++ API: Resource Bundle
*/
U_NAMESPACE_BEGIN
/**

7
icu4c/source/common/unicode/schriter.h
View File

@ -1,7 +1,7 @@
/*
******************************************************************************
*
* Copyright (C) 1998-2004, International Business Machines
* Copyright (C) 1998-2005, International Business Machines
* Corporation and others. All Rights Reserved.
*
******************************************************************************
@ -22,6 +22,11 @@
#include "unicode/chariter.h"
#include "unicode/uchriter.h"
/**
* \file
* \brief C++ API: String Character Iterator
*/
U_NAMESPACE_BEGIN
/**
* A concrete subclass of CharacterIterator that iterates over the

7
icu4c/source/common/unicode/strenum.h
View File

@ -1,7 +1,7 @@
/*
*******************************************************************************
*
* Copyright (C) 2002-2004, International Business Machines
* Copyright (C) 2002-2005, International Business Machines
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
@ -13,6 +13,11 @@
#include "unicode/uobject.h"
#include "unicode/unistr.h"
/**
* \file
* \brief C++ API: String Enumeration
*/
U_NAMESPACE_BEGIN
/**

8
icu4c/source/common/unicode/symtable.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2000-2004, International Business Machines
* Copyright (c) 2000-2005, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* Date Name Description
@ -13,6 +13,12 @@
#include "unicode/utypes.h"
#include "unicode/uobject.h"
/**
* \file
* \brief C++ API: An interface that defines both lookup protocol and parsing of
* symbolic names.
*/
U_NAMESPACE_BEGIN
class ParsePosition;

7
icu4c/source/common/unicode/uchriter.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (C) 1998-2004, International Business Machines
* Copyright (C) 1998-2005, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
*/
@ -11,6 +11,11 @@
#include "unicode/utypes.h"
#include "unicode/chariter.h"
/**
* \file
* \brief C++ API: UChar Character Iterator
*/
U_NAMESPACE_BEGIN
/**

6
icu4c/source/common/unicode/uclean.h
View File

@ -18,7 +18,11 @@
#define __UCLEAN_H__
#include "unicode/utypes.h"
/**
* \file
* \brief C API: Initialize and clean up ICU
*/
/**
* Initialize ICU. The description further below applies to ICU 2.6 to ICU 3.4.
* Starting with ICU 3.4, u_init() needs not be called any more for

7
icu4c/source/common/unicode/uenum.h
View File

@ -1,7 +1,7 @@
/*
*******************************************************************************
*
* Copyright (C) 2002-2004, International Business Machines
* Copyright (C) 2002-2005, International Business Machines
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
@ -19,6 +19,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C API: String Enumeration
*/
/**
* An enumeration object.
* For usage in C programs.

6
icu4c/source/common/unicode/uidna.h
View File

@ -1,7 +1,7 @@
/*
*******************************************************************************
*
* Copyright (C) 2003-2004, International Business Machines
* Copyright (C) 2003-2005, International Business Machines
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
@ -24,7 +24,9 @@
#include "unicode/parseerr.h"
/**
*\file
* \file
* \brief C API: Internationalized Domain Names in Applications Tranformation
*
* UIDNA API implements the IDNA protocol as defined in the IDNA RFC
* (http://www.ietf.org/rfc/rfc3490.txt).
* The RFC defines 2 operations: ToASCII and ToUnicode. Domain labels

8
icu4c/source/common/unicode/unifilt.h
View File

@ -1,5 +1,5 @@
/*
* Copyright (C) 1999-2004, International Business Machines Corporation and others.
* Copyright (C) 1999-2005, International Business Machines Corporation and others.
* All Rights Reserved.
**********************************************************************
* Date Name Description
@ -12,6 +12,11 @@
#include "unicode/unifunct.h"
#include "unicode/unimatch.h"
/**
* \file
* \brief C++ API: Unicode Filter
*/
U_NAMESPACE_BEGIN
/**
@ -25,6 +30,7 @@ U_NAMESPACE_BEGIN
#define U_ETHER ((UChar)0xFFFF)
/**
*
* <code>UnicodeFilter</code> defines a protocol for selecting a
* subset of the full range (U+0000 to U+10FFFF) of Unicode characters.
* Currently, filters are used in conjunction with classes like {@link

7
icu4c/source/common/unicode/unifunct.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2002-2004, International Business Machines Corporation
* Copyright (c) 2002-2005, International Business Machines Corporation
* and others. All Rights Reserved.
**********************************************************************
* Date Name Description
@ -13,6 +13,11 @@
#include "unicode/utypes.h"
#include "unicode/uobject.h"
/**
* \file
* \brief C++ API: Unicode Functor
*/
U_NAMESPACE_BEGIN
class UnicodeMatcher;

8
icu4c/source/common/unicode/unimatch.h
View File

@ -1,5 +1,5 @@
/*
* Copyright (C) 2001-2004, International Business Machines Corporation and others. All Rights Reserved.
* Copyright (C) 2001-2005, International Business Machines Corporation and others. All Rights Reserved.
**********************************************************************
* Date Name Description
* 07/18/01 aliu Creation.
@ -10,6 +10,12 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Unicode Matcher
*/
U_NAMESPACE_BEGIN
class Replaceable;

5
icu4c/source/common/unicode/uniset.h
View File

@ -15,6 +15,11 @@
#include "unicode/unistr.h"
#include "unicode/uset.h"
/**
* \file
* \brief C++ API: Unicode Set
*/
U_NAMESPACE_BEGIN
class ParsePosition;

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

@ -21,6 +21,11 @@
#ifndef UNISTR_H
#define UNISTR_H
/**
* \file
* \brief C++ API: Unicode String
*/
#include "unicode/rep.h"
struct UConverter; // unicode/ucnv.h

7
icu4c/source/common/unicode/urep.h
View File

@ -1,6 +1,6 @@
/*
******************************************************************************
* Copyright (C) 1997-2003, International Business Machines
* Copyright (C) 1997-2005, International Business Machines
* Corporation and others. All Rights Reserved.
******************************************************************************
* Date Name Description
@ -28,7 +28,10 @@ U_CDECL_BEGIN
/********************************************************************
* Data Structures
********************************************************************/
/**
* \file
* \brief C API: Callbacks for UReplacebale
*/
/**
* An opaque replaceable text object. This will be manipulated only
* through the caller-supplied UReplaceableFunctor struct. Related

7
icu4c/source/common/unicode/uscript.h
View File

@ -17,7 +17,12 @@
#include "unicode/utypes.h"
/**
* Constants for Unicode script values from ScriptNames.txt .
* \file
* \brief C API: Unicode Script Information
*/
/**
* Constants for Unicode script values from ScriptNames.txt.
*
* @stable ICU 2.2
*/

8
icu4c/source/common/unicode/usetiter.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2002-2004, International Business Machines
* Copyright (c) 2002-2005, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
*/
@ -11,12 +11,18 @@
#include "unicode/uobject.h"
#include "unicode/unistr.h"
/**
* \file
* \brief C++ API: UnicodeSetIterator iterates over the contents of a UnicodeSet.
*/
U_NAMESPACE_BEGIN
class UnicodeSet;
class UnicodeString;
/**
*
* UnicodeSetIterator iterates over the contents of a UnicodeSet. It
* iterates over either code points or code point ranges. After all
* code points or ranges have been returned, it returns the

9
icu4c/source/common/unicode/usprep.h
View File

@ -1,7 +1,7 @@
/*
*******************************************************************************
*
* Copyright (C) 2003-2004, International Business Machines
* Copyright (C) 2003-2005, International Business Machines
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
@ -17,9 +17,14 @@
#ifndef __USPREP_H__
#define __USPREP_H__
/**
* \file
* \brief C API: Implements the StringPrep algorithm.
*/
#include "unicode/utypes.h"
/**
*\file
*
* StringPrep API implements the StingPrep framework as described by RFC 3454.
* StringPrep prepares Unicode strings for use in network protocols.
* Profiles of StingPrep are set of rules and data according to with the

7
icu4c/source/common/unicode/utf_old.h
View File

@ -15,7 +15,12 @@
*/
/**
* \file
* \file
* \brief C API: Deprecated macros for 16-bit Unicode handling
*/
/**
*
* The macros in utf_old.h are all deprecated and their use discouraged.
* Some of the design principles behind the set of UTF macros
* have changed or proved impractical.

7
icu4c/source/common/unicode/utrace.h
View File

@ -1,7 +1,7 @@
/*
*******************************************************************************
*
* Copyright (C) 2003-2004, International Business Machines
* Copyright (C) 2003-2005, International Business Machines
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
@ -23,6 +23,11 @@
#include <stdarg.h>
#include "unicode/utypes.h"
/**
* \file
* \brief C API: Definitions for ICU tracing/logging.
*/
U_CDECL_BEGIN
#ifndef U_HIDE_DRAFT_API

4
icu4c/source/common/unicode/uversion.h
View File

@ -15,6 +15,10 @@
* Gets included by utypes.h and Windows .rc files
*/
/**
* \file
* \brief C API: Contains all the important version numbers for ICU.
*/
/*===========================================================================*/
/* Main ICU version information */
/*===========================================================================*/

6
icu4c/source/i18n/unicode/calendar.h
View File

@ -27,6 +27,10 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Calendar object
*/
#if !UCONFIG_NO_FORMATTING
#include "unicode/uobject.h"
@ -48,7 +52,7 @@ typedef const void* URegistryKey;
*/
typedef int32_t UFieldResolutionTable[12][8];
/**
/**.
* <code>Calendar</code> is an abstract base class for converting between
* a <code>UDate</code> object and a set of integer fields such as
* <code>YEAR</code>, <code>MONTH</code>, <code>DAY</code>, <code>HOUR</code>,

7
icu4c/source/i18n/unicode/choicfmt.h
View File

@ -1,6 +1,6 @@
/*
********************************************************************************
* Copyright (C) 1997-2004, International Business Machines
* Copyright (C) 1997-2005, International Business Machines
* Corporation and others. All Rights Reserved.
********************************************************************************
*
@ -24,6 +24,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Choice Format.
*/
#if !UCONFIG_NO_FORMATTING
#include "unicode/unistr.h"

5
icu4c/source/i18n/unicode/coleitr.h
View File

@ -29,6 +29,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Collation Element Iterator.
*/
#if !UCONFIG_NO_COLLATION
#include "unicode/uobject.h"

5
icu4c/source/i18n/unicode/coll.h
View File

@ -46,6 +46,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Collation Service.
*/
#if !UCONFIG_NO_COLLATION
#include "unicode/uobject.h"

8
icu4c/source/i18n/unicode/curramt.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2004, International Business Machines
* Copyright (c) 2005, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* Author: Alan Liu
@ -18,9 +18,15 @@
#include "unicode/measure.h"
#include "unicode/currunit.h"
/**
* \file
* \brief C++ API: Currency Amount Object.
*/
U_NAMESPACE_BEGIN
/**
*
* A currency together with a numeric amount, such as 200 USD.
*
* @author Alan Liu

7
icu4c/source/i18n/unicode/currunit.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2004, International Business Machines
* Copyright (c) 2005, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* Author: Alan Liu
@ -17,6 +17,11 @@
#include "unicode/measunit.h"
/**
* \file
* \brief C++ API: Currency Unit Information.
*/
U_NAMESPACE_BEGIN
/**

7
icu4c/source/i18n/unicode/datefmt.h
View File

@ -1,6 +1,6 @@
/*
********************************************************************************
* Copyright (C) 1997-2004, International Business Machines
* Copyright (C) 1997-2005, International Business Machines
* Corporation and others. All Rights Reserved.
********************************************************************************
*
@ -29,6 +29,11 @@
#include "unicode/format.h"
#include "unicode/locid.h"
/**
* \file
* \brief C++ API: Abstract class for converting dates.
*/
U_NAMESPACE_BEGIN
class TimeZone;

6
icu4c/source/i18n/unicode/dcfmtsym.h
View File

@ -32,6 +32,12 @@
#include "unicode/uobject.h"
#include "unicode/locid.h"
/**
* \file
* \brief C++ API: Symbols for formatting numbers.
*/
U_NAMESPACE_BEGIN
/**

6
icu4c/source/i18n/unicode/decimfmt.h
View File

@ -25,7 +25,11 @@
#define DECIMFMT_H
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Formats decimal numbers.
*/
#if !UCONFIG_NO_FORMATTING
#include "unicode/dcfmtsym.h"

5
icu4c/source/i18n/unicode/dtfmtsym.h
View File

@ -26,6 +26,11 @@
#include "unicode/locid.h"
#include "unicode/ures.h"
/**
* \file
* \brief C++ API: Symbols for formatting dates.
*/
U_NAMESPACE_BEGIN
/* forward declaration */

7
icu4c/source/i18n/unicode/fieldpos.h
View File

@ -1,6 +1,6 @@
/*
********************************************************************************
* Copyright (C) 1997-2004, International Business Machines
* Copyright (C) 1997-2005, International Business Machines
* Corporation and others. All Rights Reserved.
********************************************************************************
*
@ -24,6 +24,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: FieldPosition identifies the fields in a formatted output.
*/
#if !UCONFIG_NO_FORMATTING
#include "unicode/uobject.h"

4
icu4c/source/i18n/unicode/fmtable.h
View File

@ -17,6 +17,10 @@
#include "unicode/utypes.h"
#include "unicode/unistr.h"
/**
* \file
* \brief C++ API: Formattable is a thin wrapper for primitive numeric types.
*/
#if !UCONFIG_NO_FORMATTING

7
icu4c/source/i18n/unicode/format.h
View File

@ -1,6 +1,6 @@
/*
********************************************************************************
* Copyright (C) {1997-2004}, International Business Machines Corporation and others. All Rights Reserved.
* Copyright (C) {1997-2005}, International Business Machines Corporation and others. All Rights Reserved.
********************************************************************************
*
* File FORMAT.H
@ -23,6 +23,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Base class for all formats.
*/
#if !UCONFIG_NO_FORMATTING
#include "unicode/unistr.h"

9
icu4c/source/i18n/unicode/gregocal.h
View File

@ -1,5 +1,5 @@
/*
* Copyright (C) {1997-2004}, International Business Machines Corporation and others. All Rights Reserved.
* Copyright (C) {1997-2005}, International Business Machines Corporation and others. All Rights Reserved.
********************************************************************************
*
* File GREGOCAL.H
@ -29,9 +29,14 @@
#include "unicode/calendar.h"
/**
* \file
* \brief C++ API: Concrete class which provides the standard calendar.
*/
U_NAMESPACE_BEGIN
/**
/**
* Concrete class which provides the standard calendar used by most of the world.
* <P>
* The standard (Gregorian) calendar has 2 eras, BC and AD.

8
icu4c/source/i18n/unicode/measfmt.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2004, International Business Machines
* Copyright (c) 2004-2005, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* Author: Alan Liu
@ -17,9 +17,15 @@
#include "unicode/format.h"
/**
* \file
* \brief C++ API: Formatter for measure objects.
*/
U_NAMESPACE_BEGIN
/**
*
* A formatter for measure objects. This is an abstract base class.
*
* <p>To format or parse a measure object, first create a formatter

7
icu4c/source/i18n/unicode/measunit.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2004, International Business Machines
* Copyright (c) 2004-2005, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* Author: Alan Liu
@ -17,6 +17,11 @@
#include "unicode/fmtable.h"
/**
* \file
* \brief C++ API: A unit for measuring a quantity.
*/
U_NAMESPACE_BEGIN
/**

7
icu4c/source/i18n/unicode/measure.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2004, International Business Machines
* Copyright (c) 2004-2005, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* Author: Alan Liu
@ -13,6 +13,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: MeasureUnit object.
*/
#if !UCONFIG_NO_FORMATTING
#include "unicode/fmtable.h"

6
icu4c/source/i18n/unicode/msgfmt.h
View File

@ -19,6 +19,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Formats messages in a language-neutral way.
*/
#if !UCONFIG_NO_FORMATTING
#include "unicode/format.h"
@ -31,6 +36,7 @@ class NumberFormat;
class DateFormat;
/**
*
* A MessageFormat produces concatenated messages in a
* language-neutral way. It should be used for all string
* concatenations that are visible to end users.

8
icu4c/source/i18n/unicode/numfmt.h
View File

@ -1,5 +1,5 @@
/*
* Copyright (C) {1997-2004}, International Business Machines Corporation and others. All Rights Reserved.
* Copyright (C) {1997-2005}, International Business Machines Corporation and others. All Rights Reserved.
********************************************************************************
*
* File NUMFMT.H
@ -22,6 +22,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Abstract base class for all number formats.
*/
#if !UCONFIG_NO_FORMATTING
#include "unicode/unistr.h"
@ -42,6 +47,7 @@ typedef const void* URegistryKey;
#endif
/**
*
* Abstract base class for all number formats. Provides interface for
* formatting and parsing a number. Also provides methods for
* determining which locales have number formats, and what their names

8
icu4c/source/i18n/unicode/rbnf.h
View File

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 1997-2004, International Business Machines Corporation and others.
* Copyright (C) 1997-2005, International Business Machines Corporation and others.
* All Rights Reserved.
*******************************************************************************
*/
@ -10,6 +10,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Rule Based Number Format
*/
/**
* \def U_HAVE_RBNF
* This will be 0 if RBNF support is not included in ICU
@ -52,7 +57,6 @@ class Collator;
#endif
/**
* \brief C++ API: RuleBasedNumberFormat
*
* <h2> Rule Based Number Format C++ API </h2>
*

8
icu4c/source/i18n/unicode/search.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (C) 2001-2003 IBM and others. All rights reserved.
* Copyright (C) 2001-2005 IBM and others. All rights reserved.
**********************************************************************
* Date Name Description
* 03/22/2000 helena Creation.
@ -12,6 +12,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: SearchIterator object.
*/
#if !UCONFIG_NO_COLLATION
#include "unicode/uobject.h"
@ -32,6 +37,7 @@ typedef struct USearch USearch;
U_NAMESPACE_BEGIN
/**
*
* <tt>SearchIterator</tt> is an abstract base class that provides
* methods to search for a pattern within a text string. Instances of
* <tt>SearchIterator</tt> maintain a current position and scans over the

7
icu4c/source/i18n/unicode/simpletz.h
View File

@ -1,5 +1,5 @@
/*
* Copyright (C) {1997-2004}, International Business Machines Corporation and others. All Rights Reserved.
* Copyright (C) {1997-2005}, International Business Machines Corporation and others. All Rights Reserved.
* *
********************************************************************************
*
@ -25,6 +25,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: SimpleTimeZone is a concrete subclass of TimeZone.
*/
#if !UCONFIG_NO_FORMATTING
#include "unicode/timezone.h"

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

@ -25,6 +25,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Format and parse dates in a language-independent manner.
*/
#if !UCONFIG_NO_FORMATTING
#include "unicode/datefmt.h"
@ -35,6 +40,7 @@ class DateFormatSymbols;
class DateFormat;
/**
*
* SimpleDateFormat is a concrete class for formatting and parsing dates in a
* language-independent manner. It allows for formatting (millis -> text),
* parsing (text -> millis), and normalization. Formats/Parses a date or time,

8
icu4c/source/i18n/unicode/sortkey.h
View File

@ -1,5 +1,5 @@
/*
* Copyright (C) 1996-2004, International Business Machines Corporation and others.
* Copyright (C) 1996-2005, International Business Machines Corporation and others.
* All Rights Reserved.
*****************************************************************************************
*
@ -22,6 +22,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Keys for comparing strings multiple times.
*/
#if !UCONFIG_NO_COLLATION
#include "unicode/uobject.h"
@ -34,6 +39,7 @@ U_NAMESPACE_BEGIN
class RuleBasedCollator;
/**
*
* Collation keys are generated by the Collator class. Use the CollationKey objects
* instead of Collator to compare strings multiple times. A CollationKey
* preprocesses the comparison information from the Collator object to

8
icu4c/source/i18n/unicode/stsearch.h
View File

@ -12,6 +12,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Service for searching text based on RuleBasedCollator.
*/
#if !UCONFIG_NO_COLLATION
#include "unicode/tblcoll.h"
@ -20,7 +25,8 @@
U_NAMESPACE_BEGIN
/**
/**
*
* <tt>StringSearch</tt> is a <tt>SearchIterator</tt> that provides
* language-sensitive text searching based on the comparison rules defined
* in a {@link RuleBasedCollator} object.

5
icu4c/source/i18n/unicode/tblcoll.h
View File

@ -56,6 +56,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: RuleBasedCollator class provides the simple implementation of Collator.
*/
#if !UCONFIG_NO_COLLATION
#include "unicode/coll.h"

8
icu4c/source/i18n/unicode/timezone.h
View File

@ -1,5 +1,5 @@
/*
* Copyright (C) {1997-2004}, International Business Machines Corporation and others. All Rights Reserved.
* Copyright (C) {1997-2005}, International Business Machines Corporation and others. All Rights Reserved.
********************************************************************************
*
* File TIMEZONE.H
@ -28,6 +28,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: TimeZone object
*/
#if !UCONFIG_NO_FORMATTING
#include "unicode/uobject.h"
@ -39,6 +44,7 @@ U_NAMESPACE_BEGIN
class StringEnumeration;
/**
*
* <code>TimeZone</code> represents a time zone offset, and also figures out daylight
* savings.
*

6
icu4c/source/i18n/unicode/translit.h
View File

@ -12,6 +12,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: Tranforms text from one format to another.
*/
#if !UCONFIG_NO_TRANSLITERATION
#include "unicode/uobject.h"
@ -30,6 +35,7 @@ class NormalizationTransliterator;
class TransliteratorIDParser;
/**
*
* <code>Transliterator</code> is an abstract class that
* transliterates text from one format to another. The most common
* kind of transliterator is a script, or alphabet, transliterator.

5
icu4c/source/i18n/unicode/ucurr.h
View File

@ -10,6 +10,11 @@
#include "unicode/utypes.h"
#include "unicode/uenum.h"
/**
* \file
* \brief C API: Encapsulates information about a currency.
*/
#if !UCONFIG_NO_FORMATTING
/**

17
icu4c/source/i18n/unicode/udat.h
View File

@ -347,6 +347,21 @@ typedef enum UDateFormatField {
* @draft ICU 3.4
*/
UDAT_TIMEZONE_GENERIC_FIELD = 24,
/**
* FieldPosition selector for 'c' field alignment,
* corresponding to the {@link Calendar#DAY} field.
* This displays the stand alone day name, if available.
* @draft ICU 3.4
*/
UDAT_STANDALONE_DAY_FIELD = 25,
/**
* FieldPosition selector for 'L' field alignment,
* corresponding to the {@link Calendar#MONTH} field.
* This displays the stand alone month name, if available.
* @draft ICU 3.4
*/
UDAT_STANDALONE_MONTH_FIELD = 26,
/**
* Number of FieldPosition and UFieldPosition selectors for
@ -356,7 +371,7 @@ typedef enum UDateFormatField {
* in the future.
* @draft ICU 3.0
*/
UDAT_FIELD_COUNT = 25
UDAT_FIELD_COUNT = 27
} UDateFormatField;

7
icu4c/source/i18n/unicode/ulocdata.h
View File

@ -1,7 +1,7 @@
/*
******************************************************************************
* *
* Copyright (C) 2003-2004, International Business Machines *
* Copyright (C) 2003-2005, International Business Machines *
* Corporation and others. All Rights Reserved. *
* *
******************************************************************************
@ -21,7 +21,10 @@
#include "unicode/uloc.h"
#include "unicode/uset.h"
/**
* \file
* \brief C API: Provides access to locale data.
*/
/**
* Returns the set of exemplar characters for a locale.
*

7
icu4c/source/i18n/unicode/unirepl.h
View File

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2002-2004, International Business Machines Corporation
* Copyright (c) 2002-2005, International Business Machines Corporation
* and others. All Rights Reserved.
**********************************************************************
* Date Name Description
@ -12,6 +12,11 @@
#include "unicode/utypes.h"
/**
* \file
* \brief C++ API: UnicodeReplacer
*/
U_NAMESPACE_BEGIN
class Replaceable;

4
icu4c/source/layout/LEFontInstance.h
View File

@ -9,6 +9,10 @@
#define __LEFONTINSTANCE_H
#include "LETypes.h"
/**
* \file
* \brief C++ API: Layout Engine Font Instance object
*/
U_NAMESPACE_BEGIN

5
icu4c/source/layout/LEGlyphStorage.h
View File

@ -11,6 +11,11 @@
#include "LETypes.h"
#include "LEInsertionList.h"
/**
* \file
* \brief C++ API: This class encapsulates the per-glyph storage used by the ICU LayoutEngine.
*/
U_NAMESPACE_BEGIN
/**

7
icu4c/source/layout/LELanguages.h
View File

@ -1,6 +1,6 @@
/*
*
* (C) Copyright IBM Corp. 1998-2004. All Rights Reserved.
* (C) Copyright IBM Corp. 1998-2005. All Rights Reserved.
*
* WARNING: THIS FILE IS MACHINE GENERATED. DO NOT HAND EDIT IT UNLESS
* YOU REALLY KNOW WHAT YOU'RE DOING.
@ -11,6 +11,11 @@
#include "LETypes.h"
/**
* \file
* \brief C++ API: List of language codes for LayoutEngine
*/
U_NAMESPACE_BEGIN
/**

7
icu4c/source/layout/LEScripts.h
View File

@ -1,6 +1,6 @@
/*
*
* (C) Copyright IBM Corp. 1998-2004. All Rights Reserved.
* (C) Copyright IBM Corp. 1998-2005. All Rights Reserved.
*
* WARNING: THIS FILE IS MACHINE GENERATED. DO NOT HAND EDIT IT UNLESS
* YOU REALLY KNOW WHAT YOU'RE DOING.
@ -10,6 +10,11 @@
#define __LESCRIPTS_H
#include "LETypes.h"
/**
* \file
* \brief C++ API: Constants for Unicode script values
*/
U_NAMESPACE_BEGIN

7
icu4c/source/layout/LESwaps.h
View File

@ -1,7 +1,7 @@
/*
*
* (C) Copyright IBM Corp. 1998-2004 - All Rights Reserved
* (C) Copyright IBM Corp. 1998-2005 - All Rights Reserved
*
*/
@ -10,6 +10,11 @@
#include "LETypes.h"
/**
* \file
* \brief C++ API: Endian independent access to data for LayoutEngine
*/
U_NAMESPACE_BEGIN
/**

5
icu4c/source/layout/LayoutEngine.h
View File

@ -10,6 +10,11 @@
#include "LETypes.h"
/**
* \file
* \brief C++ API: Virtual base class for complex text layout.
*/
U_NAMESPACE_BEGIN
class LEFontInstance;

5
icu4c/source/layoutex/layout/ParagraphLayout.h
View File

@ -9,6 +9,11 @@
#define __PARAGRAPHLAYOUT_H
/**
* \file
* \brief C++ API: Paragraph Layout
*/
/*
* ParagraphLayout doesn't make much sense without
* BreakIterator...

5
icu4c/source/layoutex/layout/RunArrays.h
View File

@ -15,6 +15,11 @@
#include "unicode/utypes.h"
#include "unicode/locid.h"
/**
* \file
* \brief C++ API: base class for building classes which represent data that is associated with runs of text.
*/
U_NAMESPACE_BEGIN
/**