Back to home page

EIC code displayed by LXR

 
 

    


Warning, file /include/unicode/docmain.h was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).

0001 // © 2016 and later: Unicode, Inc. and others.
0002 // License & terms of use: http://www.unicode.org/copyright.html
0003 /********************************************************************
0004  * COPYRIGHT: 
0005  * Copyright (c) 1997-2012, International Business Machines Corporation and
0006  * others. All Rights Reserved.
0007  *
0008  *  FILE NAME: DOCMAIN.h
0009  *
0010  *   Date          Name        Description
0011  *   12/11/2000    Ram        Creation.
0012  */
0013 
0014 /**
0015  * \file
0016  * \brief (Non API- contains Doxygen definitions)
0017  *
0018  * This file contains documentation for Doxygen and does not have
0019  * any significance with respect to C or C++ API
0020  */
0021 
0022 /*! \mainpage
0023  *
0024  * \section API API Reference Usage
0025  * 
0026  * <h3>C++ Programmers:</h3>
0027  * <p>Use <a href="hierarchy.html">Class Hierarchy</a> or <a href="classes.html"> Alphabetical List </a>
0028  * or <a href="annotated.html"> Compound List</a>
0029  * to find the class you are interested in. For example, to find BreakIterator,
0030  * you can go to the <a href="classes.html"> Alphabetical List</a>, then click on
0031  * "BreakIterator". Once you are at the class, you will find an inheritance
0032  * chart, a list of the public members, a detailed description of the class,
0033  * then detailed member descriptions.</p>
0034  * 
0035  * <h3>C Programmers:</h3>
0036  * <p>Use <a href="#Module">Module List</a> or <a href="globals_u.html">File Members</a>
0037  * to find a list of all the functions and constants.
0038  * For example, to find BreakIterator functions you would click on
0039  * <a href="files.html"> File List</a>,
0040  * then find "ubrk.h" and click on it. You will find descriptions of Defines,
0041  * Typedefs, Enumerations, and Functions, with detailed descriptions below.
0042  * If you want to find a specific function, such as ubrk_next(), then click
0043  * first on <a href="globals.html"> File Members</a>, then use your browser
0044  * Find dialog to search for "ubrk_next()".</p>
0045  *
0046  *
0047  * <h3>API References for Previous Releases</h3>
0048  * <p>The API References for each release of ICU are also available as
0049  * a zip file from the ICU 
0050  * <a href="https://icu.unicode.org/download">download page</a>.</p>
0051  *
0052  * <hr>
0053  *
0054  * <h2>Architecture (User's Guide)</h2>
0055  * <ul>
0056  *   <li><a href="https://unicode-org.github.io/icu/userguide/">Introduction</a></li>
0057  *   <li><a href="https://unicode-org.github.io/icu/userguide/i18n">Internationalization</a></li>
0058  *   <li><a href="https://unicode-org.github.io/icu/userguide/design">Locale Model, Multithreading, Error Handling, etc.</a></li>
0059  *   <li><a href="https://unicode-org.github.io/icu/userguide/conversion">Conversion</a></li>
0060  * </ul>
0061  *
0062  * <hr>
0063  *\htmlonly <h2><a NAME="Module">Module List</a></h2> \endhtmlonly
0064  * <table border="1" cols="3" align="center">
0065  *   <tr>
0066  *     <td><strong>Module Name</strong></td>
0067  *     <td><strong>C</strong></td>
0068  *     <td><strong>C++</strong></td>
0069  *   </tr>
0070  *   <tr>
0071  *     <td>Basic Types and Constants</td>
0072  *     <td>utypes.h</td>
0073  *     <td>utypes.h</td>
0074  *   </tr>
0075  *   <tr>
0076  *     <td>Strings and Character Iteration</td>
0077  *     <td>ustring.h, utf8.h, utf16.h, icu::StringPiece, UText, UCharIterator, icu::ByteSink</td>
0078  *     <td>icu::UnicodeString, icu::CharacterIterator, icu::Appendable, icu::StringPiece,icu::ByteSink</td>
0079  *   </tr>
0080  *   <tr>
0081  *     <td>Unicode Character<br/>Properties and Names</td>
0082  *     <td>uchar.h, uscript.h</td>
0083  *     <td>C API</td>
0084  *   </tr>
0085  *   <tr>
0086  *     <td>Sets of Unicode Code Points and Strings</td>
0087  *     <td>uset.h</td>
0088  *     <td>icu::UnicodeSet</td>
0089  *   </tr>
0090  *   <tr>
0091  *     <td>Maps from Unicode Code Points to Integer Values</td>
0092  *     <td>ucptrie.h, umutablecptrie.h</td>
0093  *     <td>C API</td>
0094  *   </tr>
0095  *   <tr>
0096  *     <td>Maps from Strings to Integer Values</td>
0097  *     <td>(no C API)</td>
0098  *     <td>icu::BytesTrie, icu::UCharsTrie</td>
0099  *   </tr>
0100  *   <tr>
0101  *     <td>Codepage Conversion</td>
0102  *     <td>ucnv.h, ucnvsel.h</td>
0103  *     <td>C API</td>
0104  *   </tr>
0105  *   <tr>
0106  *     <td>Codepage Detection</td>
0107  *     <td>ucsdet.h</td>
0108  *     <td>C API</td>
0109  *   </tr>
0110  *   <tr>
0111  *     <td>Unicode Text Compression</td>
0112  *     <td>ucnv.h<br/>(encoding name "SCSU" or "BOCU-1")</td>
0113  *     <td>C API</td>
0114  *   </tr>
0115  *   <tr>
0116  *     <td>Locales </td>
0117  *     <td>uloc.h, ulocale.h, ulocbuilder.h</a></td>
0118  *     <td>icu::Locale, icu::LocaleBuilder, icu::LocaleMatcher</td>
0119  *   </tr>
0120  *   <tr>
0121  *     <td>Resource Bundles</td>
0122  *     <td>ures.h</td>
0123  *     <td>icu::ResourceBundle</td>
0124  *   </tr>
0125  *   <tr>
0126  *     <td>Normalization</td>
0127  *     <td>unorm2.h</td>
0128  *     <td>icu::Normalizer2</td>
0129  *   </tr>
0130  *   <tr>
0131  *     <td>Calendars and Time Zones</td>
0132  *     <td>ucal.h</td>
0133  *     <td>icu::Calendar, icu::TimeZone</td>
0134  *   </tr>
0135  *   <tr>
0136  *     <td>Date and Time Formatting</td>
0137  *     <td>udat.h</td>
0138  *     <td>icu::DateFormat</td>
0139  *   </tr>
0140  *   <tr>
0141  *     <td>Message Formatting</td>
0142  *     <td>umsg.h</td>
0143  *     <td>icu::MessageFormat</td>
0144  *   </tr>
0145  *   <tr>
0146  *     <td>List Formatting</td>
0147  *     <td>ulistformatter.h</td>
0148  *     <td>icu::ListFormatter</td>
0149  *   </tr>
0150  *   <tr>
0151  *     <td>Number Formatting<br/>(includes currency and unit formatting)</td>
0152  *     <td>unumberformatter.h, unum.h, usimplenumberformatter.h</td>
0153  *     <td>icu::number::NumberFormatter (ICU 60+) or icu::NumberFormat (older versions)<br>icu::number::SimpleNumberFormatter (ICU 73+)</td>
0154  *   </tr>
0155  *   <tr>
0156  *     <td>Number Range Formatting<br />(includes currency and unit ranges)</td>
0157  *     <td>unumberrangeformatter.h</td>
0158  *     <td>icu::number::NumberRangeFormatter</td>
0159  *   </tr>
0160  *   <tr>
0161  *     <td>Number Spellout<br/>(Rule Based Number Formatting)</td>
0162  *     <td>unum.h<br/>(use UNUM_SPELLOUT)</td>
0163  *     <td>icu::RuleBasedNumberFormat</td>
0164  *   </tr>
0165  *   <tr>
0166  *     <td>Text Transformation<br/>(Transliteration)</td>
0167  *     <td>utrans.h</td>
0168  *     <td>icu::Transliterator</td>
0169  *   </tr>
0170  *   <tr>
0171  *     <td>Bidirectional Algorithm</td>
0172  *     <td>ubidi.h, ubiditransform.h</td>
0173  *     <td>C API</td>
0174  *   </tr>
0175  *   <tr>
0176  *     <td>Arabic Shaping</td>
0177  *     <td>ushape.h</td>
0178  *     <td>C API</td>
0179  *   </tr>
0180  *   <tr>
0181  *     <td>Collation</td>
0182  *     <td>ucol.h</td>
0183  *     <td>icu::Collator</td>
0184  *   </tr>
0185  *   <tr>
0186  *     <td>String Searching</td>
0187  *     <td>usearch.h</td>
0188  *     <td>icu::StringSearch</td>
0189  *   </tr>
0190  *   <tr>
0191  *     <td>Index Characters/<br/>Bucketing for Sorted Lists</td>
0192  *     <td>(no C API)</td>
0193  *     <td>icu::AlphabeticIndex</td>
0194  *   </tr>
0195  *   <tr>
0196  *     <td>Text Boundary Analysis<br/>(Break Iteration)</td>
0197  *     <td>ubrk.h</td>
0198  *     <td>icu::BreakIterator</td>
0199  *   </tr>
0200  *   <tr>
0201  *     <td>Regular Expressions</td>
0202  *     <td>uregex.h</td>
0203  *     <td>icu::RegexPattern, icu::RegexMatcher</td>
0204  *   </tr>
0205  *   <tr>
0206  *     <td>StringPrep</td>
0207  *     <td>usprep.h</td>
0208  *     <td>C API</td>
0209  *   </tr>
0210  *   <tr>
0211  *     <td>International Domain Names in Applications:<br/>
0212  *         UTS #46 in C/C++, IDNA2003 only via C API</td>
0213  *     <td>uidna.h</td>
0214  *     <td>idna.h</td>
0215  *   </tr>
0216  *   <tr>
0217  *     <td>Identifier Spoofing & Confusability</td>
0218  *     <td>uspoof.h</td>
0219  *     <td>C API</td>
0220  *   <tr>
0221  *     <td>Universal Time Scale</td>
0222  *     <td>utmscale.h</td>
0223  *     <td>C API</td>
0224  *   </tr>
0225  *   <tr>
0226  *     <td>Paragraph Layout / Complex Text Layout</td>
0227  *     <td>playout.h</td>
0228  *     <td>icu::ParagraphLayout</td>
0229  *   </tr>
0230  *   <tr>
0231  *     <td>ICU I/O</td>
0232  *     <td>ustdio.h</td>
0233  *     <td>ustream.h</td>
0234  *   </tr>
0235  * </table>
0236  * <i>This main page is generated from docmain.h</i>
0237  */