1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/********************************************************************
4 * COPYRIGHT:
5 * Copyright (c) 1997-2012, International Business Machines Corporation and
6 * others. All Rights Reserved.
7 *
8 *  FILE NAME: DOCMAIN.h
9 *
10 *   Date          Name        Description
11 *   12/11/2000    Ram        Creation.
12 */
13
14/**
15 * \file
16 * \brief (Non API- contains Doxygen definitions)
17 *
18 * This file contains documentation for Doxygen and doesnot have
19 * any significance with respect to C or C++ API
20 */
21
22/*! \mainpage
23 *
24 * \section API API Reference Usage
25 *
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>
34 *
35 * <h3>C Programmers:</h3>
36 * <p>Use <a href="#Module">Module List</a> or <a href="globals.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>
45 *
46 *
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>
51 *
52 * <hr>
53 *
54 * <h2>Architecture (User's Guide)</h2>
55 * <ul>
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>
60 * </ul>
61 *
62 * <hr>
63 *\htmlonly <h2><a NAME="Module">Module List</a></h2> \endhtmlonly
64 * <table border="1" cols="3" align="center">
65 *   <tr>
66 *     <td><strong>Module Name</strong></td>
67 *     <td><strong>C</strong></td>
68 *     <td><strong>C++</strong></td>
69 *   </tr>
70 *   <tr>
71 *     <td>Basic Types and Constants</td>
72 *     <td>utypes.h</td>
73 *     <td>utypes.h</td>
74 *   </tr>
75 *   <tr>
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>
79 *   </tr>
80 *   <tr>
81 *     <td>Unicode Character<br/>Properties and Names</td>
82 *     <td>uchar.h, uscript.h</td>
83 *     <td>C API</td>
84 *   </tr>
85 *   <tr>
86 *     <td>Sets of Unicode Code Points and Strings</td>
87 *     <td>uset.h</td>
88 *     <td>icu::UnicodeSet</td>
89 *   </tr>
90 *   <tr>
91 *     <td>Maps from Strings to Integer Values</td>
92 *     <td>(no C API)</td>
93 *     <td>icu::BytesTrie, icu::UCharsTrie</td>
94 *   </tr>
95 *   <tr>
96 *     <td>Codepage Conversion</td>
97 *     <td>ucnv.h, ucnvsel.hb</td>
98 *     <td>C API</td>
99 *   </tr>
100 *   <tr>
101 *     <td>Codepage Detection</td>
102 *     <td>ucsdet.h</td>
103 *     <td>C API</td>
104 *   </tr>
105 *   <tr>
106 *     <td>Unicode Text Compression</td>
107 *     <td>ucnv.h<br/>(encoding name "SCSU" or "BOCU-1")</td>
108 *     <td>C API</td>
109 *   </tr>
110 *   <tr>
111 *     <td>Locales </td>
112 *     <td>uloc.h</a></td>
113 *     <td>icu::Locale</td>
114 *   </tr>
115 *   <tr>
116 *     <td>Resource Bundles</td>
117 *     <td>ures.h</td>
118 *     <td>icu::ResourceBundle</td>
119 *   </tr>
120 *   <tr>
121 *     <td>Normalization</td>
122 *     <td>unorm2.h</td>
123 *     <td>icu::Normalizer2</td>
124 *   </tr>
125 *   <tr>
126 *     <td>Calendars</td>
127 *     <td>ucal.h</td>
128 *     <td>icu::Calendar</td>
129 *   </tr>
130 *   <tr>
131 *     <td>Date and Time Formatting</td>
132 *     <td>udat.h</td>
133 *     <td>icu::DateFormat</td>
134 *   </tr>
135 *   <tr>
136 *     <td>Message Formatting</td>
137 *     <td>umsg.h</td>
138 *     <td>icu::MessageFormat</td>
139 *   </tr>
140 *   <tr>
141 *     <td>Number Formatting</td>
142 *     <td>unum.h</td>
143 *     <td>icu::number::NumberFormatter (ICU 60+) or icu::NumberFormat (older versions)</td>
144 *   </tr>
145 *   <tr>
146 *     <td>Number Spellout<br/>(Rule Based Number Formatting)</td>
147 *     <td>unum.h<br/>(use UNUM_SPELLOUT)</td>
148 *     <td>icu::RuleBasedNumberFormat</td>
149 *   </tr>
150 *   <tr>
151 *     <td>Text Transformation<br/>(Transliteration)</td>
152 *     <td>utrans.h</td>
153 *     <td>icu::Transliterator</td>
154 *   </tr>
155 *   <tr>
156 *     <td>Bidirectional Algorithm</td>
157 *     <td>ubidi.h, ubiditransform.h</td>
158 *     <td>C API</td>
159 *   </tr>
160 *   <tr>
161 *     <td>Arabic Shaping</td>
162 *     <td>ushape.h</td>
163 *     <td>C API</td>
164 *   </tr>
165 *   <tr>
166 *     <td>Collation</td>
167 *     <td>ucol.h</td>
168 *     <td>icu::Collator</td>
169 *   </tr>
170 *   <tr>
171 *     <td>String Searching</td>
172 *     <td>usearch.h</td>
173 *     <td>icu::StringSearch</td>
174 *   </tr>
175 *   <tr>
176 *     <td>Index Characters/<br/>Bucketing for Sorted Lists</td>
177 *     <td>(no C API)</td>
178 *     <td>icu::AlphabeticIndex</td>
179 *   </tr>
180 *   <tr>
181 *     <td>Text Boundary Analysis<br/>(Break Iteration)</td>
182 *     <td>ubrk.h</td>
183 *     <td>icu::BreakIterator</td>
184 *   </tr>
185 *   <tr>
186 *     <td>Regular Expressions</td>
187 *     <td>uregex.h</td>
188 *     <td>icu::RegexPattern, icu::RegexMatcher</td>
189 *   </tr>
190 *   <tr>
191 *     <td>StringPrep</td>
192 *     <td>usprep.h</td>
193 *     <td>C API</td>
194 *   </tr>
195 *   <tr>
196 *     <td>International Domain Names in Applications:<br/>
197 *         UTS #46 in C/C++, IDNA2003 only via C API</td>
198 *     <td>uidna.h</td>
199 *     <td>idna.h</td>
200 *   </tr>
201 *   <tr>
202 *     <td>Identifier Spoofing & Confusability</td>
203 *     <td>uspoof.h</td>
204 *     <td>C API</td>
205 *   <tr>
206 *     <td>Universal Time Scale</td>
207 *     <td>utmscale.h</td>
208 *     <td>C API</td>
209 *   </tr>
210 *   <tr>
211 *     <td>Layout Engine/Complex Text Layout</td>
212 *     <td>loengine.h</td>
213 *     <td>icu::LayoutEngine,icu::ParagraphLayout</td>
214 *   </tr>
215 *   <tr>
216 *     <td>ICU I/O</td>
217 *     <td>ustdio.h</td>
218 *     <td>ustream.h</td>
219 *   </tr>
220 * </table>
221 * <i>This main page is generated from docmain.h</i>
222 */
223