OLD | NEW |
| (Empty) |
1 /******************************************************************** | |
2 * COPYRIGHT: | |
3 * Copyright (c) 1997-2010, International Business Machines Corporation and | |
4 * others. All Rights Reserved. | |
5 * | |
6 * FILE NAME: DOCMAIN.h | |
7 * | |
8 * Date Name Description | |
9 * 12/11/2000 Ram Creation. | |
10 */ | |
11 | |
12 /* This file contains documentation for Doxygen and doesnot have | |
13 * any significance with respect to C or C++ API | |
14 */ | |
15 | |
16 /*! \mainpage | |
17 * | |
18 * \section API API Reference Usage | |
19 * | |
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 o
n | |
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> | |
28 * | |
29 * <h3>C Programmers:</h3> | |
30 * <p>Use <a href="#Module">Module List</a> or <a href="globals.html">File Membe
rs</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> | |
39 * | |
40 * | |
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://icu-project.org/download/">download page</a>.</p> | |
45 * | |
46 * <hr> | |
47 * | |
48 * <h2>Architecture (User's Guide)</h2> | |
49 * <ul> | |
50 * <li><a href="http://icu-project.org/userguide/">Introduction</a></li> | |
51 * <li><a href="http://icu-project.org/userguide/i18n.html">Internationalizati
on</a></li> | |
52 * <li><a href="http://icu-project.org/userguide/design.html">Locale Model</a>
</li> | |
53 * <li><a href="http://icu-project.org/userguide/design.html">Multithreading</
a></li> | |
54 * <li><a href="http://icu-project.org/userguide/conversion.html">Conversion</
a></li> | |
55 * <li><a href="http://icu-project.org/userguide/design.html">Error Handling</
a></li> | |
56 * </ul> | |
57 * | |
58 * <hr> | |
59 *\htmlonly <h2><a NAME="Module">Module List</a></h2> \endhtmlonly | |
60 * <table border="1" cols="3" align="center"> | |
61 * <tr> | |
62 * <td><strong>Module Name</strong></td> | |
63 * <td><strong>C</strong></td> | |
64 * <td><strong>C++</strong></td> | |
65 * </tr> | |
66 * <tr> | |
67 * <td>Basic Types and Constants</td> | |
68 * <td>utypes.h</td> | |
69 * <td>utypes.h</td> | |
70 * </tr> | |
71 * <tr> | |
72 * <td>Strings and Character Iteration</td> | |
73 * <td>ustring.h, utf.h</td> | |
74 * <td>UnicodeString, CharacterIterator</td> | |
75 * </tr> | |
76 * <tr> | |
77 * <td>Unicode Character<br>Properties and Names</td> | |
78 * <td>uchar.h</td> | |
79 * <td>uchar.h C API</td> | |
80 * </tr> | |
81 * <tr> | |
82 * <td>Codepage Conversion</td> | |
83 * <td>ucnv.h</td> | |
84 * <td>ucnv.h C API</td> | |
85 * </tr> | |
86 * <tr> | |
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> | |
90 * </tr> | |
91 * <tr> | |
92 * <td>Locales </td> | |
93 * <td>uloc.h</a></td> | |
94 * <td>Locale</td> | |
95 * </tr> | |
96 * <tr> | |
97 * <td>Resource Bundles</td> | |
98 * <td>ures.h</td> | |
99 * <td>ResourceBundle</td> | |
100 * </tr> | |
101 * <tr> | |
102 * <td>Normalization</td> | |
103 * <td>unorm.h</td> | |
104 * <td>Normalizer</td> | |
105 * </tr> | |
106 * <tr> | |
107 * <td>Calendars</td> | |
108 * <td>ucal.h</td> | |
109 * <td>Calendar</td> | |
110 * </tr> | |
111 * <tr> | |
112 * <td>Date and Time Formatting</td> | |
113 * <td>udat.h</td> | |
114 * <td>DateFormat</td> | |
115 * </tr> | |
116 * <tr> | |
117 * <td>Message Formatting</td> | |
118 * <td>umsg.h</td> | |
119 * <td>MessageFormat</td> | |
120 * </tr> | |
121 * <tr> | |
122 * <td>Number Formatting</td> | |
123 * <td>unum.h</td> | |
124 * <td>NumberFormat</td> | |
125 * </tr> | |
126 * <tr> | |
127 * <td>Number Spellout <br> (Rule Based Number Formatting)</td> | |
128 * <td>unum.h <br> (use UNUM_SPELLOUT)</td> | |
129 * <td>RuleBasedNumberFormat</td> | |
130 * </tr> | |
131 * <tr> | |
132 * <td>Text Transformation <br> (Transliteration)</td> | |
133 * <td>utrans.h</td> | |
134 * <td>Transliterator</td> | |
135 * </tr> | |
136 * <tr> | |
137 * <td>Bidirectional Algorithm</td> | |
138 * <td>ubidi.h</td> | |
139 * <td>ubidi.h C API</td> | |
140 * </tr> | |
141 * <tr> | |
142 * <td>Arabic Shaping</td> | |
143 * <td>ushape.h</td> | |
144 * <td>ushape.h C API</td> | |
145 * </tr> | |
146 * <tr> | |
147 * <td>Collation</td> | |
148 * <td>ucol.h</td> | |
149 * <td>Collator</td> | |
150 * </tr> | |
151 * <tr> | |
152 * <td>String Searching</td> | |
153 * <td>usearch.h</td> | |
154 * <td>StringSearch</td> | |
155 * </tr> | |
156 * <tr> | |
157 * <td>Text Boundary Analysis <br> (Break Iteration)</td> | |
158 * <td>ubrk.h</td> | |
159 * <td>BreakIterator</td> | |
160 * </tr> | |
161 * <tr> | |
162 * <td>Unicode Set</td> | |
163 * <td>uset.h</td> | |
164 * <td>UnicodeSet</td> | |
165 * </tr> | |
166 * <tr> | |
167 * <td>Regular Expressions</td> | |
168 * <td>uregex.h</td> | |
169 * <td>RegexPattern, RegexMatcher</td> | |
170 * </tr> | |
171 * <tr> | |
172 * <td>StringPrep</td> | |
173 * <td>usprep.h</td> | |
174 * <td>usprep.h C API</td> | |
175 * </tr> | |
176 * <tr> | |
177 * <td>International Domain Names in Applications</td> | |
178 * <td>uidna.h</td> | |
179 * <td>uidna.h C API</td> | |
180 * </tr> | |
181 * <tr> | |
182 * <td>Identifier Spoofing & Confusability</td> | |
183 * <td>uspoof.h</td> | |
184 * <td>uspoof.h C API</td> | |
185 * <tr> | |
186 * <td>Universal Time Scale</td> | |
187 * <td>utmscale.h</td> | |
188 * <td>utmscale.h C API</td> | |
189 * </tr> | |
190 * <tr> | |
191 * <td>Basic Layout Engine Types and Constants</td> | |
192 * <td>(no C API)</td> | |
193 * <td>LETypes.h</td> | |
194 * </tr> | |
195 * <tr> | |
196 * <td>Complex Text Layout</td> | |
197 * <td>(no C API)</td> | |
198 * <td>LayoutEngine, ParagraphLayout</td> | |
199 * </tr> | |
200 * <tr> | |
201 * <td>ICU I/O</td> | |
202 * <td>ustdio.h</td> | |
203 * <td>ustream.h</td> | |
204 * </tr> | |
205 * </table> | |
206 * <i>This main page is generated from docmain.h</i> | |
207 */ | |
OLD | NEW |