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