1 /********************************************************************
3 * Copyright (c) 1997-2005, International Business Machines Corporation and
4 * others. All Rights Reserved.
8 * Date Name Description
9 * 12/11/2000 Ram Creation.
12 /* This file contains documentation for Doxygen and doesnot have
13 * any significance with respect to C or C++ API
18 * \section API API Reference Usage
20 * <h3>C++ Programmers:</h3>
21 * <p>Use <a href="hierarchy.html">Class Hierarchy</a> or <a href="classes.html"> Alphabetical List </a>
22 * or <a href="annotated.html"> Compound List</a>
23 * to find the class you are interested in. For example, to find BreakIterator,
24 * you can go to the <a href="classes.html"> Alphabetical List</a>, then click on
25 * "BreakIterator". Once you are at the class, you will find an inheritance
26 * chart, a list of the public members, a detailed description of the class,
27 * then detailed member descriptions.</p>
29 * <h3>C Programmers:</h3>
30 * <p>Use <a href="#Module">Module List</a> or <a href="globals.html">File Members</a>
31 * to find a list of all the functions and constants.
32 * For example, to find BreakIterator functions you would click on
33 * <a href="files.html"> File List</a>,
34 * then find "ubrk.h" and click on it. You will find descriptions of Defines,
35 * Typedefs, Enumerations, and Functions, with detailed descriptions below.
36 * If you want to find a specific function, such as ubrk_next(), then click
37 * first on <a href="globals.html"> File Members</a>, then use your browser
38 * Find dialog to search for "ubrk_next()".</p>
41 * <h3>API References for Previous Releases</h3>
42 * <p>The API References for each release of ICU are also available as
43 * a zip file from the ICU
44 * <a href="http://www.ibm.com/software/globalization/icu/downloads.jsp">download page</a>.</p>
48 * <h2>Architecture (User's Guide)</h2>
50 * <li><a href="http://icu.sourceforge.net/userguide/">Introduction</a></li>
51 * <li><a href="http://icu.sourceforge.net/userguide/i18n.html">Internationalization</a></li>
52 * <li><a href="http://icu.sourceforge.net/userguide/design.html">Locale Model</a></li>
53 * <li><a href="http://icu.sourceforge.net/userguide/design.html">Multithreading</a></li>
54 * <li><a href="http://icu.sourceforge.net/userguide/conversion.html">Conversion</a></li>
55 * <li><a href="http://icu.sourceforge.net/userguide/design.html">Error Handling</a></li>
59 *\htmlonly <h2><a NAME="Module">Module List</a></h2> \endhtmlonly
60 * <table border="1" cols="3" align="center">
62 * <td><strong>Module Name</strong></td>
63 * <td><strong>C</strong></td>
64 * <td><strong>C++</strong></td>
67 * <td>Basic Types and Constants</td>
72 * <td>Strings and Character Iteration</td>
73 * <td>ustring.h, utf.h</td>
74 * <td>UnicodeString, CharacterIterator</td>
77 * <td>Unicode Character<br>Properties and Names</td>
79 * <td>uchar.h C API</td>
82 * <td>Codepage Conversion</td>
84 * <td>ucnv.h C API</td>
87 * <td>Unicode Text Compression</td>
88 * <td>ucnv.h <br> (encoding name "SCSU" or "BOCU-1")</td>
89 * <td>ucnv.h C API</td>
97 * <td>Resource Bundles</td>
99 * <td>ResourceBundle</td>
102 * <td>Normalization</td>
104 * <td>Normalizer</td>
112 * <td>Date and Time Formatting</td>
114 * <td>DateFormat</td>
117 * <td>Message Formatting</td>
119 * <td>MessageFormat</td>
122 * <td>Number Formatting</td>
124 * <td>NumberFormat</td>
127 * <td>Number Spellout <br> (Rule Based Number Formatting)</td>
128 * <td>unum.h <br> (use UNUM_SPELLOUT)</td>
129 * <td>RuleBasedNumberFormat</td>
132 * <td>Text Transformation <br> (Transliteration)</td>
134 * <td>Transliterator</td>
137 * <td>Bidirectional Algorithm</td>
139 * <td>ubidi.h C API</td>
142 * <td>Arabic Shaping</td>
144 * <td>ushape.h C API</td>
152 * <td>String Searching</td>
154 * <td>StringSearch</td>
157 * <td>Text Boundary Analysis <br> (Break Iteration)</td>
159 * <td>BreakIterator</td>
162 * <td>Unicode Set</td>
164 * <td>UnicodeSet</td>
167 * <td>Regular Expressions</td>
169 * <td>RegexPattern, RegexMatcher</td>
172 * <td>StringPrep</td>
174 * <td>usprep.h C API</td>
177 * <td>International Domain Names in Applications</td>
179 * <td>uidna.h C API</td>
182 * <td>Universal Time Scale</td>
183 * <td>utmscale.h</td>
184 * <td>utmscale.h C API</td>
187 * <td>Basic Layout Engine Types and Constants</td>
188 * <td>(no C API)</td>
192 * <td>Complex Text Layout</td>
193 * <td>(no C API)</td>
194 * <td>LayoutEngine, ParagraphLayout</td>