1 /******************************************************************** 2 * COPYRIGHT: 3 * Copyright (c) 1997-2011, 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 on 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 Members</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://site.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://userguide.icu-project.org/">Introduction</a></li> 51 * <li><a href="http://userguide.icu-project.org/i18n">Internationalization</a></li> 52 * <li><a href="http://userguide.icu-project.org/design">Locale Model, Multithreading, Error Handling, etc.</a></li> 53 * <li><a href="http://userguide.icu-project.org/conversion">Conversion</a></li> 54 * </ul> 55 * 56 * <hr> 57 *\htmlonly <h2><a NAME="Module">Module List</a></h2> \endhtmlonly 58 * <table border="1" cols="3" align="center"> 59 * <tr> 60 * <td><strong>Module Name</strong></td> 61 * <td><strong>C</strong></td> 62 * <td><strong>C++</strong></td> 63 * </tr> 64 * <tr> 65 * <td>Basic Types and Constants</td> 66 * <td>utypes.h</td> 67 * <td>utypes.h</td> 68 * </tr> 69 * <tr> 70 * <td>Strings and Character Iteration</td> 71 * <td>ustring.h, utf8.h, utf16.h, UText, UCharIterator</td> 72 * <td>UnicodeString, CharacterIterator, Appendable, StringPiece, ByteSink</td> 73 * </tr> 74 * <tr> 75 * <td>Unicode Character<br>Properties and Names</td> 76 * <td>uchar.h, uscript.h</td> 77 * <td>C API</td> 78 * </tr> 79 * <tr> 80 * <td>Sets of Unicode Code Points and Strings</td> 81 * <td>uset.h</td> 82 * <td>UnicodeSet</td> 83 * </tr> 84 * <tr> 85 * <td>Maps from Strings to Integer Values</td> 86 * <td>(no C API)</td> 87 * <td>BytesTrie, UCharsTrie</td> 88 * </tr> 89 * <tr> 90 * <td>Codepage Conversion</td> 91 * <td>ucnv.h, ucnvsel.hb</td> 92 * <td>C API</td> 93 * </tr> 94 * <tr> 95 * <td>Unicode Text Compression</td> 96 * <td>ucnv.h<br>(encoding name "SCSU" or "BOCU-1")</td> 97 * <td>C API</td> 98 * </tr> 99 * <tr> 100 * <td>Locales </td> 101 * <td>uloc.h</a></td> 102 * <td>Locale</td> 103 * </tr> 104 * <tr> 105 * <td>Resource Bundles</td> 106 * <td>ures.h</td> 107 * <td>ResourceBundle</td> 108 * </tr> 109 * <tr> 110 * <td>Normalization</td> 111 * <td>unorm2.h</td> 112 * <td>Normalizer2</td> 113 * </tr> 114 * <tr> 115 * <td>Calendars</td> 116 * <td>ucal.h</td> 117 * <td>Calendar</td> 118 * </tr> 119 * <tr> 120 * <td>Date and Time Formatting</td> 121 * <td>udat.h</td> 122 * <td>DateFormat</td> 123 * </tr> 124 * <tr> 125 * <td>Message Formatting</td> 126 * <td>umsg.h</td> 127 * <td>MessageFormat</td> 128 * </tr> 129 * <tr> 130 * <td>Number Formatting</td> 131 * <td>unum.h</td> 132 * <td>NumberFormat</td> 133 * </tr> 134 * <tr> 135 * <td>Number Spellout<br>(Rule Based Number Formatting)</td> 136 * <td>unum.h<br>(use UNUM_SPELLOUT)</td> 137 * <td>RuleBasedNumberFormat</td> 138 * </tr> 139 * <tr> 140 * <td>Text Transformation<br>(Transliteration)</td> 141 * <td>utrans.h</td> 142 * <td>Transliterator</td> 143 * </tr> 144 * <tr> 145 * <td>Bidirectional Algorithm</td> 146 * <td>ubidi.h</td> 147 * <td>C API</td> 148 * </tr> 149 * <tr> 150 * <td>Arabic Shaping</td> 151 * <td>ushape.h</td> 152 * <td>C API</td> 153 * </tr> 154 * <tr> 155 * <td>Collation</td> 156 * <td>ucol.h</td> 157 * <td>Collator</td> 158 * </tr> 159 * <tr> 160 * <td>String Searching</td> 161 * <td>usearch.h</td> 162 * <td>StringSearch</td> 163 * </tr> 164 * <tr> 165 * <td>Index Characters/<br>Bucketing for Sorted Lists</td> 166 * <td>(no C API)</td> 167 * <td>AlphabeticIndex</td> 168 * </tr> 169 * <tr> 170 * <td>Text Boundary Analysis<br>(Break Iteration)</td> 171 * <td>ubrk.h</td> 172 * <td>BreakIterator</td> 173 * </tr> 174 * <tr> 175 * <td>Regular Expressions</td> 176 * <td>uregex.h</td> 177 * <td>RegexPattern, RegexMatcher</td> 178 * </tr> 179 * <tr> 180 * <td>StringPrep</td> 181 * <td>usprep.h</td> 182 * <td>C API</td> 183 * </tr> 184 * <tr> 185 * <td>International Domain Names in Applications:<br> 186 * UTS #46 in C/C++, IDNA2003 only via C API</td> 187 * <td>uidna.h</td> 188 * <td>idna.h</td> 189 * </tr> 190 * <tr> 191 * <td>Identifier Spoofing & Confusability</td> 192 * <td>uspoof.h</td> 193 * <td>C API</td> 194 * <tr> 195 * <td>Universal Time Scale</td> 196 * <td>utmscale.h</td> 197 * <td>C API</td> 198 * </tr> 199 * <tr> 200 * <td>Layout Engine/Complex Text Layout</td> 201 * <td>loengine.h</td> 202 * <td>LayoutEngine, ParagraphLayout</td> 203 * </tr> 204 * <tr> 205 * <td>ICU I/O</td> 206 * <td>ustdio.h</td> 207 * <td>ustream.h</td> 208 * </tr> 209 * </table> 210 * <i>This main page is generated from docmain.h</i> 211 */ 212
