|
sl@0
|
1 |
/********************************************************************
|
|
sl@0
|
2 |
* COPYRIGHT:
|
|
sl@0
|
3 |
* Copyright (c) 1997-2005, International Business Machines Corporation and
|
|
sl@0
|
4 |
* others. All Rights Reserved.
|
|
sl@0
|
5 |
*
|
|
sl@0
|
6 |
* FILE NAME: DOCMAIN.h
|
|
sl@0
|
7 |
*
|
|
sl@0
|
8 |
* Date Name Description
|
|
sl@0
|
9 |
* 12/11/2000 Ram Creation.
|
|
sl@0
|
10 |
*/
|
|
sl@0
|
11 |
|
|
sl@0
|
12 |
/* This file contains documentation for Doxygen and doesnot have
|
|
sl@0
|
13 |
* any significance with respect to C or C++ API
|
|
sl@0
|
14 |
*/
|
|
sl@0
|
15 |
|
|
sl@0
|
16 |
/*! \mainpage
|
|
sl@0
|
17 |
*
|
|
sl@0
|
18 |
* \section API API Reference Usage
|
|
sl@0
|
19 |
*
|
|
sl@0
|
20 |
* <h3>C++ Programmers:</h3>
|
|
sl@0
|
21 |
* <p>Use <a href="hierarchy.html">Class Hierarchy</a> or <a href="classes.html"> Alphabetical List </a>
|
|
sl@0
|
22 |
* or <a href="annotated.html"> Compound List</a>
|
|
sl@0
|
23 |
* to find the class you are interested in. For example, to find BreakIterator,
|
|
sl@0
|
24 |
* you can go to the <a href="classes.html"> Alphabetical List</a>, then click on
|
|
sl@0
|
25 |
* "BreakIterator". Once you are at the class, you will find an inheritance
|
|
sl@0
|
26 |
* chart, a list of the public members, a detailed description of the class,
|
|
sl@0
|
27 |
* then detailed member descriptions.</p>
|
|
sl@0
|
28 |
*
|
|
sl@0
|
29 |
* <h3>C Programmers:</h3>
|
|
sl@0
|
30 |
* <p>Use <a href="#Module">Module List</a> or <a href="globals.html">File Members</a>
|
|
sl@0
|
31 |
* to find a list of all the functions and constants.
|
|
sl@0
|
32 |
* For example, to find BreakIterator functions you would click on
|
|
sl@0
|
33 |
* <a href="files.html"> File List</a>,
|
|
sl@0
|
34 |
* then find "ubrk.h" and click on it. You will find descriptions of Defines,
|
|
sl@0
|
35 |
* Typedefs, Enumerations, and Functions, with detailed descriptions below.
|
|
sl@0
|
36 |
* If you want to find a specific function, such as ubrk_next(), then click
|
|
sl@0
|
37 |
* first on <a href="globals.html"> File Members</a>, then use your browser
|
|
sl@0
|
38 |
* Find dialog to search for "ubrk_next()".</p>
|
|
sl@0
|
39 |
*
|
|
sl@0
|
40 |
*
|
|
sl@0
|
41 |
* <h3>API References for Previous Releases</h3>
|
|
sl@0
|
42 |
* <p>The API References for each release of ICU are also available as
|
|
sl@0
|
43 |
* a zip file from the ICU
|
|
sl@0
|
44 |
* <a href="http://www.ibm.com/software/globalization/icu/downloads.jsp">download page</a>.</p>
|
|
sl@0
|
45 |
*
|
|
sl@0
|
46 |
* <hr>
|
|
sl@0
|
47 |
*
|
|
sl@0
|
48 |
* <h2>Architecture (User's Guide)</h2>
|
|
sl@0
|
49 |
* <ul>
|
|
sl@0
|
50 |
* <li><a href="http://icu.sourceforge.net/userguide/">Introduction</a></li>
|
|
sl@0
|
51 |
* <li><a href="http://icu.sourceforge.net/userguide/i18n.html">Internationalization</a></li>
|
|
sl@0
|
52 |
* <li><a href="http://icu.sourceforge.net/userguide/design.html">Locale Model</a></li>
|
|
sl@0
|
53 |
* <li><a href="http://icu.sourceforge.net/userguide/design.html">Multithreading</a></li>
|
|
sl@0
|
54 |
* <li><a href="http://icu.sourceforge.net/userguide/conversion.html">Conversion</a></li>
|
|
sl@0
|
55 |
* <li><a href="http://icu.sourceforge.net/userguide/design.html">Error Handling</a></li>
|
|
sl@0
|
56 |
* </ul>
|
|
sl@0
|
57 |
*
|
|
sl@0
|
58 |
* <hr>
|
|
sl@0
|
59 |
*\htmlonly <h2><a NAME="Module">Module List</a></h2> \endhtmlonly
|
|
sl@0
|
60 |
* <table border="1" cols="3" align="center">
|
|
sl@0
|
61 |
* <tr>
|
|
sl@0
|
62 |
* <td><strong>Module Name</strong></td>
|
|
sl@0
|
63 |
* <td><strong>C</strong></td>
|
|
sl@0
|
64 |
* <td><strong>C++</strong></td>
|
|
sl@0
|
65 |
* </tr>
|
|
sl@0
|
66 |
* <tr>
|
|
sl@0
|
67 |
* <td>Basic Types and Constants</td>
|
|
sl@0
|
68 |
* <td>utypes.h</td>
|
|
sl@0
|
69 |
* <td>utypes.h</td>
|
|
sl@0
|
70 |
* </tr>
|
|
sl@0
|
71 |
* <tr>
|
|
sl@0
|
72 |
* <td>Strings and Character Iteration</td>
|
|
sl@0
|
73 |
* <td>ustring.h, utf.h</td>
|
|
sl@0
|
74 |
* <td>UnicodeString, CharacterIterator</td>
|
|
sl@0
|
75 |
* </tr>
|
|
sl@0
|
76 |
* <tr>
|
|
sl@0
|
77 |
* <td>Unicode Character<br>Properties and Names</td>
|
|
sl@0
|
78 |
* <td>uchar.h</td>
|
|
sl@0
|
79 |
* <td>uchar.h C API</td>
|
|
sl@0
|
80 |
* </tr>
|
|
sl@0
|
81 |
* <tr>
|
|
sl@0
|
82 |
* <td>Codepage Conversion</td>
|
|
sl@0
|
83 |
* <td>ucnv.h</td>
|
|
sl@0
|
84 |
* <td>ucnv.h C API</td>
|
|
sl@0
|
85 |
* </tr>
|
|
sl@0
|
86 |
* <tr>
|
|
sl@0
|
87 |
* <td>Unicode Text Compression</td>
|
|
sl@0
|
88 |
* <td>ucnv.h <br> (encoding name "SCSU" or "BOCU-1")</td>
|
|
sl@0
|
89 |
* <td>ucnv.h C API</td>
|
|
sl@0
|
90 |
* </tr>
|
|
sl@0
|
91 |
* <tr>
|
|
sl@0
|
92 |
* <td>Locales </td>
|
|
sl@0
|
93 |
* <td>uloc.h</a></td>
|
|
sl@0
|
94 |
* <td>Locale</td>
|
|
sl@0
|
95 |
* </tr>
|
|
sl@0
|
96 |
* <tr>
|
|
sl@0
|
97 |
* <td>Resource Bundles</td>
|
|
sl@0
|
98 |
* <td>ures.h</td>
|
|
sl@0
|
99 |
* <td>ResourceBundle</td>
|
|
sl@0
|
100 |
* </tr>
|
|
sl@0
|
101 |
* <tr>
|
|
sl@0
|
102 |
* <td>Normalization</td>
|
|
sl@0
|
103 |
* <td>unorm.h</td>
|
|
sl@0
|
104 |
* <td>Normalizer</td>
|
|
sl@0
|
105 |
* </tr>
|
|
sl@0
|
106 |
* <tr>
|
|
sl@0
|
107 |
* <td>Calendars</td>
|
|
sl@0
|
108 |
* <td>ucal.h</td>
|
|
sl@0
|
109 |
* <td>Calendar</td>
|
|
sl@0
|
110 |
* </tr>
|
|
sl@0
|
111 |
* <tr>
|
|
sl@0
|
112 |
* <td>Date and Time Formatting</td>
|
|
sl@0
|
113 |
* <td>udat.h</td>
|
|
sl@0
|
114 |
* <td>DateFormat</td>
|
|
sl@0
|
115 |
* </tr>
|
|
sl@0
|
116 |
* <tr>
|
|
sl@0
|
117 |
* <td>Message Formatting</td>
|
|
sl@0
|
118 |
* <td>umsg.h</td>
|
|
sl@0
|
119 |
* <td>MessageFormat</td>
|
|
sl@0
|
120 |
* </tr>
|
|
sl@0
|
121 |
* <tr>
|
|
sl@0
|
122 |
* <td>Number Formatting</td>
|
|
sl@0
|
123 |
* <td>unum.h</td>
|
|
sl@0
|
124 |
* <td>NumberFormat</td>
|
|
sl@0
|
125 |
* </tr>
|
|
sl@0
|
126 |
* <tr>
|
|
sl@0
|
127 |
* <td>Number Spellout <br> (Rule Based Number Formatting)</td>
|
|
sl@0
|
128 |
* <td>unum.h <br> (use UNUM_SPELLOUT)</td>
|
|
sl@0
|
129 |
* <td>RuleBasedNumberFormat</td>
|
|
sl@0
|
130 |
* </tr>
|
|
sl@0
|
131 |
* <tr>
|
|
sl@0
|
132 |
* <td>Text Transformation <br> (Transliteration)</td>
|
|
sl@0
|
133 |
* <td>utrans.h</td>
|
|
sl@0
|
134 |
* <td>Transliterator</td>
|
|
sl@0
|
135 |
* </tr>
|
|
sl@0
|
136 |
* <tr>
|
|
sl@0
|
137 |
* <td>Bidirectional Algorithm</td>
|
|
sl@0
|
138 |
* <td>ubidi.h</td>
|
|
sl@0
|
139 |
* <td>ubidi.h C API</td>
|
|
sl@0
|
140 |
* </tr>
|
|
sl@0
|
141 |
* <tr>
|
|
sl@0
|
142 |
* <td>Arabic Shaping</td>
|
|
sl@0
|
143 |
* <td>ushape.h</td>
|
|
sl@0
|
144 |
* <td>ushape.h C API</td>
|
|
sl@0
|
145 |
* </tr>
|
|
sl@0
|
146 |
* <tr>
|
|
sl@0
|
147 |
* <td>Collation</td>
|
|
sl@0
|
148 |
* <td>ucol.h</td>
|
|
sl@0
|
149 |
* <td>Collator</td>
|
|
sl@0
|
150 |
* </tr>
|
|
sl@0
|
151 |
* <tr>
|
|
sl@0
|
152 |
* <td>String Searching</td>
|
|
sl@0
|
153 |
* <td>usearch.h</td>
|
|
sl@0
|
154 |
* <td>StringSearch</td>
|
|
sl@0
|
155 |
* </tr>
|
|
sl@0
|
156 |
* <tr>
|
|
sl@0
|
157 |
* <td>Text Boundary Analysis <br> (Break Iteration)</td>
|
|
sl@0
|
158 |
* <td>ubrk.h</td>
|
|
sl@0
|
159 |
* <td>BreakIterator</td>
|
|
sl@0
|
160 |
* </tr>
|
|
sl@0
|
161 |
* <tr>
|
|
sl@0
|
162 |
* <td>Unicode Set</td>
|
|
sl@0
|
163 |
* <td>uset.h</td>
|
|
sl@0
|
164 |
* <td>UnicodeSet</td>
|
|
sl@0
|
165 |
* </tr>
|
|
sl@0
|
166 |
* <tr>
|
|
sl@0
|
167 |
* <td>Regular Expressions</td>
|
|
sl@0
|
168 |
* <td>uregex.h</td>
|
|
sl@0
|
169 |
* <td>RegexPattern, RegexMatcher</td>
|
|
sl@0
|
170 |
* </tr>
|
|
sl@0
|
171 |
* <tr>
|
|
sl@0
|
172 |
* <td>StringPrep</td>
|
|
sl@0
|
173 |
* <td>usprep.h</td>
|
|
sl@0
|
174 |
* <td>usprep.h C API</td>
|
|
sl@0
|
175 |
* </tr>
|
|
sl@0
|
176 |
* <tr>
|
|
sl@0
|
177 |
* <td>International Domain Names in Applications</td>
|
|
sl@0
|
178 |
* <td>uidna.h</td>
|
|
sl@0
|
179 |
* <td>uidna.h C API</td>
|
|
sl@0
|
180 |
* </tr>
|
|
sl@0
|
181 |
* <tr>
|
|
sl@0
|
182 |
* <td>Universal Time Scale</td>
|
|
sl@0
|
183 |
* <td>utmscale.h</td>
|
|
sl@0
|
184 |
* <td>utmscale.h C API</td>
|
|
sl@0
|
185 |
* </tr>
|
|
sl@0
|
186 |
* <tr>
|
|
sl@0
|
187 |
* <td>Basic Layout Engine Types and Constants</td>
|
|
sl@0
|
188 |
* <td>(no C API)</td>
|
|
sl@0
|
189 |
* <td>LETypes.h</td>
|
|
sl@0
|
190 |
* </tr>
|
|
sl@0
|
191 |
* <tr>
|
|
sl@0
|
192 |
* <td>Complex Text Layout</td>
|
|
sl@0
|
193 |
* <td>(no C API)</td>
|
|
sl@0
|
194 |
* <td>LayoutEngine, ParagraphLayout</td>
|
|
sl@0
|
195 |
* </tr>
|
|
sl@0
|
196 |
* <tr>
|
|
sl@0
|
197 |
* <td>ICU I/O</td>
|
|
sl@0
|
198 |
* <td>ustdio.h</td>
|
|
sl@0
|
199 |
* <td>ustream.h</td>
|
|
sl@0
|
200 |
* </tr>
|
|
sl@0
|
201 |
* </table>
|
|
sl@0
|
202 |
*/
|