docmain.h (7839B)
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 does not 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_u.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="https://icu.unicode.org/download">download page</a>.</p> 51 * 52 * <hr> 53 * 54 * <h2>Architecture (User's Guide)</h2> 55 * <ul> 56 * <li><a href="https://unicode-org.github.io/icu/userguide/">Introduction</a></li> 57 * <li><a href="https://unicode-org.github.io/icu/userguide/i18n">Internationalization</a></li> 58 * <li><a href="https://unicode-org.github.io/icu/userguide/design">Locale Model, Multithreading, Error Handling, etc.</a></li> 59 * <li><a href="https://unicode-org.github.io/icu/userguide/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, icu::StringPiece, UText, UCharIterator, icu::ByteSink</td> 78 * <td>icu::UnicodeString, utfiterator.h (ICU 78+), icu::CharacterIterator, icu::Appendable,<br> 79 * icu::StringPiece, icu::ByteSink</td> 80 * </tr> 81 * <tr> 82 * <td>Unicode Character<br/>Properties and Names</td> 83 * <td>uchar.h, uscript.h</td> 84 * <td>C API</td> 85 * </tr> 86 * <tr> 87 * <td>Sets of Unicode Code Points and Strings</td> 88 * <td>uset.h</td> 89 * <td>icu::UnicodeSet</td> 90 * </tr> 91 * <tr> 92 * <td>Maps from Unicode Code Points to Integer Values</td> 93 * <td>ucptrie.h, umutablecptrie.h</td> 94 * <td>C API</td> 95 * </tr> 96 * <tr> 97 * <td>Maps from Strings to Integer Values</td> 98 * <td>(no C API)</td> 99 * <td>icu::BytesTrie, icu::UCharsTrie</td> 100 * </tr> 101 * <tr> 102 * <td>Codepage Conversion</td> 103 * <td>ucnv.h, ucnvsel.h</td> 104 * <td>C API</td> 105 * </tr> 106 * <tr> 107 * <td>Codepage Detection</td> 108 * <td>ucsdet.h</td> 109 * <td>C API</td> 110 * </tr> 111 * <tr> 112 * <td>Unicode Text Compression</td> 113 * <td>ucnv.h<br/>(encoding name "SCSU" or "BOCU-1")</td> 114 * <td>C API</td> 115 * </tr> 116 * <tr> 117 * <td>Locales </td> 118 * <td>uloc.h, ulocale.h, ulocbuilder.h</a></td> 119 * <td>icu::Locale, icu::LocaleBuilder, icu::LocaleMatcher</td> 120 * </tr> 121 * <tr> 122 * <td>Resource Bundles</td> 123 * <td>ures.h</td> 124 * <td>icu::ResourceBundle</td> 125 * </tr> 126 * <tr> 127 * <td>Normalization</td> 128 * <td>unorm2.h</td> 129 * <td>icu::Normalizer2</td> 130 * </tr> 131 * <tr> 132 * <td>Calendars and Time Zones</td> 133 * <td>ucal.h</td> 134 * <td>icu::Calendar, icu::TimeZone</td> 135 * </tr> 136 * <tr> 137 * <td>Date and Time Formatting</td> 138 * <td>udat.h</td> 139 * <td>icu::DateFormat</td> 140 * </tr> 141 * <tr> 142 * <td>Relative Date and Time Formatting</td> 143 * <td>ureldatefmt.h</td> 144 * <td>icu::RelativeDateTimeFormatter</td> 145 * </tr> 146 * <tr> 147 * <td>Message Formatting</td> 148 * <td>umsg.h</td> 149 * <td>icu::MessageFormat</td> 150 * </tr> 151 * <tr> 152 * <td>Message Formatting 2<br/>(technology preview)</td> 153 * <td>(no C API)</td> 154 * <td>icu::message2::MessageFormatter</td> 155 * </tr> 156 * <tr> 157 * <td>List Formatting</td> 158 * <td>ulistformatter.h</td> 159 * <td>icu::ListFormatter</td> 160 * </tr> 161 * <tr> 162 * <td>Number Formatting<br/>(includes currency and unit formatting)</td> 163 * <td>unumberformatter.h, unum.h, usimplenumberformatter.h</td> 164 * <td>icu::number::NumberFormatter (ICU 60+) or icu::NumberFormat (older versions)<br> 165 * icu::number::SimpleNumberFormatter (ICU 73+)</td> 166 * </tr> 167 * <tr> 168 * <td>Number Range Formatting<br />(includes currency and unit ranges)</td> 169 * <td>unumberrangeformatter.h</td> 170 * <td>icu::number::NumberRangeFormatter</td> 171 * </tr> 172 * <tr> 173 * <td>Number Spellout<br/>(Rule Based Number Formatting)</td> 174 * <td>unum.h<br/>(use UNUM_SPELLOUT)</td> 175 * <td>icu::RuleBasedNumberFormat</td> 176 * </tr> 177 * <tr> 178 * <td>Text Transformation<br/>(Transliteration)</td> 179 * <td>utrans.h</td> 180 * <td>icu::Transliterator</td> 181 * </tr> 182 * <tr> 183 * <td>Bidirectional Algorithm</td> 184 * <td>ubidi.h, ubiditransform.h</td> 185 * <td>C API</td> 186 * </tr> 187 * <tr> 188 * <td>Arabic Shaping</td> 189 * <td>ushape.h</td> 190 * <td>C API</td> 191 * </tr> 192 * <tr> 193 * <td>Collation</td> 194 * <td>ucol.h</td> 195 * <td>icu::Collator</td> 196 * </tr> 197 * <tr> 198 * <td>String Searching</td> 199 * <td>usearch.h</td> 200 * <td>icu::StringSearch</td> 201 * </tr> 202 * <tr> 203 * <td>Index Characters/<br/>Bucketing for Sorted Lists</td> 204 * <td>(no C API)</td> 205 * <td>icu::AlphabeticIndex</td> 206 * </tr> 207 * <tr> 208 * <td>Text Boundary Analysis<br/>(Break Iteration)</td> 209 * <td>ubrk.h</td> 210 * <td>icu::BreakIterator</td> 211 * </tr> 212 * <tr> 213 * <td>Regular Expressions</td> 214 * <td>uregex.h</td> 215 * <td>icu::RegexPattern, icu::RegexMatcher</td> 216 * </tr> 217 * <tr> 218 * <td>StringPrep</td> 219 * <td>usprep.h</td> 220 * <td>C API</td> 221 * </tr> 222 * <tr> 223 * <td>International Domain Names in Applications:<br/> 224 * UTS #46 in C/C++, IDNA2003 only via C API</td> 225 * <td>uidna.h</td> 226 * <td>idna.h</td> 227 * </tr> 228 * <tr> 229 * <td>Identifier Spoofing & Confusability</td> 230 * <td>uspoof.h</td> 231 * <td>C API</td> 232 * <tr> 233 * <td>Universal Time Scale</td> 234 * <td>utmscale.h</td> 235 * <td>C API</td> 236 * </tr> 237 * <tr> 238 * <td>Paragraph Layout / Complex Text Layout</td> 239 * <td>playout.h</td> 240 * <td>icu::ParagraphLayout</td> 241 * </tr> 242 * <tr> 243 * <td>ICU I/O</td> 244 * <td>ustdio.h</td> 245 * <td>ustream.h</td> 246 * </tr> 247 * </table> 248 * <i>This main page is generated from docmain.h</i> 249 */