Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/unicode/docmain.h @ 69:33d812a61356

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