]>
git.saurik.com Git - apple/icu.git/blob - icuSources/common/unicode/docmain.h
704139a85ed558eedfa738eb2bf3fbc8b4bb119f
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /********************************************************************
5 * Copyright (c) 1997-2012, International Business Machines Corporation and
6 * others. All Rights Reserved.
10 * Date Name Description
11 * 12/11/2000 Ram Creation.
16 * \brief (Non API- contains Doxygen definitions)
18 * This file contains documentation for Doxygen and doesnot have
19 * any significance with respect to C or C++ API
24 * \section API API Reference Usage
26 * <h3>C++ Programmers:</h3>
27 * <p>Use <a href="hierarchy.html">Class Hierarchy</a> or <a href="classes.html"> Alphabetical List </a>
28 * or <a href="annotated.html"> Compound List</a>
29 * to find the class you are interested in. For example, to find BreakIterator,
30 * you can go to the <a href="classes.html"> Alphabetical List</a>, then click on
31 * "BreakIterator". Once you are at the class, you will find an inheritance
32 * chart, a list of the public members, a detailed description of the class,
33 * then detailed member descriptions.</p>
35 * <h3>C Programmers:</h3>
36 * <p>Use <a href="#Module">Module List</a> or <a href="globals_u.html">File Members</a>
37 * to find a list of all the functions and constants.
38 * For example, to find BreakIterator functions you would click on
39 * <a href="files.html"> File List</a>,
40 * then find "ubrk.h" and click on it. You will find descriptions of Defines,
41 * Typedefs, Enumerations, and Functions, with detailed descriptions below.
42 * If you want to find a specific function, such as ubrk_next(), then click
43 * first on <a href="globals.html"> File Members</a>, then use your browser
44 * Find dialog to search for "ubrk_next()".</p>
47 * <h3>API References for Previous Releases</h3>
48 * <p>The API References for each release of ICU are also available as
49 * a zip file from the ICU
50 * <a href="http://site.icu-project.org/download">download page</a>.</p>
54 * <h2>Architecture (User's Guide)</h2>
56 * <li><a href="http://userguide.icu-project.org/">Introduction</a></li>
57 * <li><a href="http://userguide.icu-project.org/i18n">Internationalization</a></li>
58 * <li><a href="http://userguide.icu-project.org/design">Locale Model, Multithreading, Error Handling, etc.</a></li>
59 * <li><a href="http://userguide.icu-project.org/conversion">Conversion</a></li>
63 *\htmlonly <h2><a NAME="Module">Module List</a></h2> \endhtmlonly
64 * <table border="1" cols="3" align="center">
66 * <td><strong>Module Name</strong></td>
67 * <td><strong>C</strong></td>
68 * <td><strong>C++</strong></td>
71 * <td>Basic Types and Constants</td>
76 * <td>Strings and Character Iteration</td>
77 * <td>ustring.h, utf8.h, utf16.h, UText, UCharIterator</td>
78 * <td>icu::UnicodeString, icu::CharacterIterator, icu::Appendable, icu::StringPiece,icu::ByteSink</td>
81 * <td>Unicode Character<br/>Properties and Names</td>
82 * <td>uchar.h, uscript.h</td>
86 * <td>Sets of Unicode Code Points and Strings</td>
88 * <td>icu::UnicodeSet</td>
91 * <td>Maps from Unicode Code Points to Integer Values</td>
92 * <td>ucptrie.h, umutablecptrie.h</td>
96 * <td>Maps from Strings to Integer Values</td>
98 * <td>icu::BytesTrie, icu::UCharsTrie</td>
101 * <td>Codepage Conversion</td>
102 * <td>ucnv.h, ucnvsel.h</td>
106 * <td>Codepage Detection</td>
111 * <td>Unicode Text Compression</td>
112 * <td>ucnv.h<br/>(encoding name "SCSU" or "BOCU-1")</td>
117 * <td>uloc.h</a></td>
118 * <td>icu::Locale, icu::LocaleBuilder, icu::LocaleMatcher</td>
121 * <td>Resource Bundles</td>
123 * <td>icu::ResourceBundle</td>
126 * <td>Normalization</td>
128 * <td>icu::Normalizer2</td>
133 * <td>icu::Calendar</td>
136 * <td>Date and Time Formatting</td>
138 * <td>icu::DateFormat</td>
141 * <td>Message Formatting</td>
143 * <td>icu::MessageFormat</td>
146 * <td>Number Formatting<br/>(includes currency and unit formatting)</td>
147 * <td>unumberformatter.h, unum.h</td>
148 * <td>icu::number::NumberFormatter (ICU 60+) or icu::NumberFormat (older versions)</td>
151 * <td>Number Range Formatting<br />(includes currency and unit ranges)</td>
152 * <td>(no C API)</td>
153 * <td>icu::number::NumberRangeFormatter</td>
156 * <td>Number Spellout<br/>(Rule Based Number Formatting)</td>
157 * <td>unum.h<br/>(use UNUM_SPELLOUT)</td>
158 * <td>icu::RuleBasedNumberFormat</td>
161 * <td>Text Transformation<br/>(Transliteration)</td>
163 * <td>icu::Transliterator</td>
166 * <td>Bidirectional Algorithm</td>
167 * <td>ubidi.h, ubiditransform.h</td>
171 * <td>Arabic Shaping</td>
178 * <td>icu::Collator</td>
181 * <td>String Searching</td>
183 * <td>icu::StringSearch</td>
186 * <td>Index Characters/<br/>Bucketing for Sorted Lists</td>
187 * <td>(no C API)</td>
188 * <td>icu::AlphabeticIndex</td>
191 * <td>Text Boundary Analysis<br/>(Break Iteration)</td>
193 * <td>icu::BreakIterator</td>
196 * <td>Regular Expressions</td>
198 * <td>icu::RegexPattern, icu::RegexMatcher</td>
201 * <td>StringPrep</td>
206 * <td>International Domain Names in Applications:<br/>
207 * UTS #46 in C/C++, IDNA2003 only via C API</td>
212 * <td>Identifier Spoofing & Confusability</td>
216 * <td>Universal Time Scale</td>
217 * <td>utmscale.h</td>
221 * <td>Paragraph Layout / Complex Text Layout</td>
223 * <td>icu::ParagraphLayout</td>
231 * <i>This main page is generated from docmain.h</i>
projects / apple / icu.git / blob