jpayne@69: // © 2016 and later: Unicode, Inc. and others. jpayne@69: // License & terms of use: http://www.unicode.org/copyright.html jpayne@69: /******************************************************************** jpayne@69: * COPYRIGHT: jpayne@69: * Copyright (c) 1997-2012, International Business Machines Corporation and jpayne@69: * others. All Rights Reserved. jpayne@69: * jpayne@69: * FILE NAME: DOCMAIN.h jpayne@69: * jpayne@69: * Date Name Description jpayne@69: * 12/11/2000 Ram Creation. jpayne@69: */ jpayne@69: jpayne@69: /** jpayne@69: * \file jpayne@69: * \brief (Non API- contains Doxygen definitions) jpayne@69: * jpayne@69: * This file contains documentation for Doxygen and doesnot have jpayne@69: * any significance with respect to C or C++ API jpayne@69: */ jpayne@69: jpayne@69: /*! \mainpage jpayne@69: * jpayne@69: * \section API API Reference Usage jpayne@69: * jpayne@69: *

C++ Programmers:

jpayne@69: *

Use Class Hierarchy or Alphabetical List jpayne@69: * or Compound List jpayne@69: * to find the class you are interested in. For example, to find BreakIterator, jpayne@69: * you can go to the Alphabetical List, then click on jpayne@69: * "BreakIterator". Once you are at the class, you will find an inheritance jpayne@69: * chart, a list of the public members, a detailed description of the class, jpayne@69: * then detailed member descriptions.

jpayne@69: * jpayne@69: *

C Programmers:

jpayne@69: *

Use Module List or File Members jpayne@69: * to find a list of all the functions and constants. jpayne@69: * For example, to find BreakIterator functions you would click on jpayne@69: * File List, jpayne@69: * then find "ubrk.h" and click on it. You will find descriptions of Defines, jpayne@69: * Typedefs, Enumerations, and Functions, with detailed descriptions below. jpayne@69: * If you want to find a specific function, such as ubrk_next(), then click jpayne@69: * first on File Members, then use your browser jpayne@69: * Find dialog to search for "ubrk_next()".

jpayne@69: * jpayne@69: * jpayne@69: *

API References for Previous Releases

jpayne@69: *

The API References for each release of ICU are also available as jpayne@69: * a zip file from the ICU jpayne@69: * download page.

jpayne@69: * jpayne@69: *
jpayne@69: * jpayne@69: *

Architecture (User's Guide)

jpayne@69: * jpayne@69: * jpayne@69: *
jpayne@69: *\htmlonly

Module List

\endhtmlonly jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: * jpayne@69: *
Module NameCC++
Basic Types and Constantsutypes.hutypes.h
Strings and Character Iterationustring.h, utf8.h, utf16.h, UText, UCharIteratoricu::UnicodeString, icu::CharacterIterator, icu::Appendable, icu::StringPiece,icu::ByteSink
Unicode Character
Properties and Names		uchar.h, uscript.hC API
Sets of Unicode Code Points and Stringsuset.hicu::UnicodeSet
Maps from Unicode Code Points to Integer Valuesucptrie.h, umutablecptrie.hC API
Maps from Strings to Integer Values(no C API)icu::BytesTrie, icu::UCharsTrie
Codepage Conversionucnv.h, ucnvsel.hC API
Codepage Detectionucsdet.hC API
Unicode Text Compressionucnv.h
(encoding name "SCSU" or "BOCU-1")		C API
Locales uloc.hicu::Locale, icu::LocaleBuilder, icu::LocaleMatcher
Resource Bundlesures.hicu::ResourceBundle
Normalizationunorm2.hicu::Normalizer2
Calendarsucal.hicu::Calendar
Date and Time Formattingudat.hicu::DateFormat
Message Formattingumsg.hicu::MessageFormat
Number Formatting
(includes currency and unit formatting)		unumberformatter.h, unum.hicu::number::NumberFormatter (ICU 60+) or icu::NumberFormat (older versions)
Number Range Formatting
(includes currency and unit ranges)		(no C API)icu::number::NumberRangeFormatter
Number Spellout
(Rule Based Number Formatting)		unum.h
(use UNUM_SPELLOUT)		icu::RuleBasedNumberFormat
Text Transformation
(Transliteration)		utrans.hicu::Transliterator
Bidirectional Algorithmubidi.h, ubiditransform.hC API
Arabic Shapingushape.hC API
Collationucol.hicu::Collator
String Searchingusearch.hicu::StringSearch
Index Characters/
Bucketing for Sorted Lists		(no C API)icu::AlphabeticIndex
Text Boundary Analysis
(Break Iteration)		ubrk.hicu::BreakIterator
Regular Expressionsuregex.hicu::RegexPattern, icu::RegexMatcher
StringPrepusprep.hC API
International Domain Names in Applications:
jpayne@69: * UTS #46 in C/C++, IDNA2003 only via C API		uidna.hidna.h
Identifier Spoofing & Confusabilityuspoof.hC API
Universal Time Scaleutmscale.hC API
Paragraph Layout / Complex Text Layoutplayout.hicu::ParagraphLayout
ICU I/Oustdio.hustream.h
jpayne@69: * This main page is generated from docmain.h jpayne@69: */