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