| // © 2016 and later: Unicode, Inc. and others. |
| // License & terms of use: http://www.unicode.org/copyright.html |
| /******************************************************************** |
| * COPYRIGHT: |
| * Copyright (c) 1997-2012, International Business Machines Corporation and |
| * others. All Rights Reserved. |
| * |
| * FILE NAME: DOCMAIN.h |
| * |
| * Date Name Description |
| * 12/11/2000 Ram Creation. |
| */ |
| |
| /** |
| * \file |
| * \brief (Non API- contains Doxygen definitions) |
| * |
| * This file contains documentation for Doxygen and doesnot have |
| * any significance with respect to C or C++ API |
| */ |
| |
| /*! \mainpage |
| * |
| * \section API API Reference Usage |
| * |
| * <h3>C++ Programmers:</h3> |
| * <p>Use <a href="hierarchy.html">Class Hierarchy</a> or <a href="classes.html"> Alphabetical List </a> |
| * or <a href="annotated.html"> Compound List</a> |
| * to find the class you are interested in. For example, to find BreakIterator, |
| * you can go to the <a href="classes.html"> Alphabetical List</a>, then click on |
| * "BreakIterator". Once you are at the class, you will find an inheritance |
| * chart, a list of the public members, a detailed description of the class, |
| * then detailed member descriptions.</p> |
| * |
| * <h3>C Programmers:</h3> |
| * <p>Use <a href="#Module">Module List</a> or <a href="globals_u.html">File Members</a> |
| * to find a list of all the functions and constants. |
| * For example, to find BreakIterator functions you would click on |
| * <a href="files.html"> File List</a>, |
| * then find "ubrk.h" and click on it. You will find descriptions of Defines, |
| * Typedefs, Enumerations, and Functions, with detailed descriptions below. |
| * If you want to find a specific function, such as ubrk_next(), then click |
| * first on <a href="globals.html"> File Members</a>, then use your browser |
| * Find dialog to search for "ubrk_next()".</p> |
| * |
| * |
| * <h3>API References for Previous Releases</h3> |
| * <p>The API References for each release of ICU are also available as |
| * a zip file from the ICU |
| * <a href="http://site.icu-project.org/download">download page</a>.</p> |
| * |
| * <hr> |
| * |
| * <h2>Architecture (User's Guide)</h2> |
| * <ul> |
| * <li><a href="http://userguide.icu-project.org/">Introduction</a></li> |
| * <li><a href="http://userguide.icu-project.org/i18n">Internationalization</a></li> |
| * <li><a href="http://userguide.icu-project.org/design">Locale Model, Multithreading, Error Handling, etc.</a></li> |
| * <li><a href="http://userguide.icu-project.org/conversion">Conversion</a></li> |
| * </ul> |
| * |
| * <hr> |
| *\htmlonly <h2><a NAME="Module">Module List</a></h2> \endhtmlonly |
| * <table border="1" cols="3" align="center"> |
| * <tr> |
| * <td><strong>Module Name</strong></td> |
| * <td><strong>C</strong></td> |
| * <td><strong>C++</strong></td> |
| * </tr> |
| * <tr> |
| * <td>Basic Types and Constants</td> |
| * <td>utypes.h</td> |
| * <td>utypes.h</td> |
| * </tr> |
| * <tr> |
| * <td>Strings and Character Iteration</td> |
| * <td>ustring.h, utf8.h, utf16.h, UText, UCharIterator</td> |
| * <td>icu::UnicodeString, icu::CharacterIterator, icu::Appendable, icu::StringPiece,icu::ByteSink</td> |
| * </tr> |
| * <tr> |
| * <td>Unicode Character<br/>Properties and Names</td> |
| * <td>uchar.h, uscript.h</td> |
| * <td>C API</td> |
| * </tr> |
| * <tr> |
| * <td>Sets of Unicode Code Points and Strings</td> |
| * <td>uset.h</td> |
| * <td>icu::UnicodeSet</td> |
| * </tr> |
| * <tr> |
| * <td>Maps from Unicode Code Points to Integer Values</td> |
| * <td>ucptrie.h, umutablecptrie.h</td> |
| * <td>C API</td> |
| * </tr> |
| * <tr> |
| * <td>Maps from Strings to Integer Values</td> |
| * <td>(no C API)</td> |
| * <td>icu::BytesTrie, icu::UCharsTrie</td> |
| * </tr> |
| * <tr> |
| * <td>Codepage Conversion</td> |
| * <td>ucnv.h, ucnvsel.hb</td> |
| * <td>C API</td> |
| * </tr> |
| * <tr> |
| * <td>Codepage Detection</td> |
| * <td>ucsdet.h</td> |
| * <td>C API</td> |
| * </tr> |
| * <tr> |
| * <td>Unicode Text Compression</td> |
| * <td>ucnv.h<br/>(encoding name "SCSU" or "BOCU-1")</td> |
| * <td>C API</td> |
| * </tr> |
| * <tr> |
| * <td>Locales </td> |
| * <td>uloc.h</a></td> |
| * <td>icu::Locale, icu::LocaleBuilder</td> |
| * </tr> |
| * <tr> |
| * <td>Resource Bundles</td> |
| * <td>ures.h</td> |
| * <td>icu::ResourceBundle</td> |
| * </tr> |
| * <tr> |
| * <td>Normalization</td> |
| * <td>unorm2.h</td> |
| * <td>icu::Normalizer2</td> |
| * </tr> |
| * <tr> |
| * <td>Calendars</td> |
| * <td>ucal.h</td> |
| * <td>icu::Calendar</td> |
| * </tr> |
| * <tr> |
| * <td>Date and Time Formatting</td> |
| * <td>udat.h</td> |
| * <td>icu::DateFormat</td> |
| * </tr> |
| * <tr> |
| * <td>Message Formatting</td> |
| * <td>umsg.h</td> |
| * <td>icu::MessageFormat</td> |
| * </tr> |
| * <tr> |
| * <td>Number Formatting<br/>(includes currency and unit formatting)</td> |
| * <td>unumberformatter.h, unum.h</td> |
| * <td>icu::number::NumberFormatter (ICU 60+) or icu::NumberFormat (older versions)</td> |
| * </tr> |
| * <tr> |
| * <td>Number Range Formatting<br />(includes currency and unit ranges)</td> |
| * <td>(no C API)</td> |
| * <td>icu::number::NumberRangeFormatter</td> |
| * </tr> |
| * <tr> |
| * <td>Number Spellout<br/>(Rule Based Number Formatting)</td> |
| * <td>unum.h<br/>(use UNUM_SPELLOUT)</td> |
| * <td>icu::RuleBasedNumberFormat</td> |
| * </tr> |
| * <tr> |
| * <td>Text Transformation<br/>(Transliteration)</td> |
| * <td>utrans.h</td> |
| * <td>icu::Transliterator</td> |
| * </tr> |
| * <tr> |
| * <td>Bidirectional Algorithm</td> |
| * <td>ubidi.h, ubiditransform.h</td> |
| * <td>C API</td> |
| * </tr> |
| * <tr> |
| * <td>Arabic Shaping</td> |
| * <td>ushape.h</td> |
| * <td>C API</td> |
| * </tr> |
| * <tr> |
| * <td>Collation</td> |
| * <td>ucol.h</td> |
| * <td>icu::Collator</td> |
| * </tr> |
| * <tr> |
| * <td>String Searching</td> |
| * <td>usearch.h</td> |
| * <td>icu::StringSearch</td> |
| * </tr> |
| * <tr> |
| * <td>Index Characters/<br/>Bucketing for Sorted Lists</td> |
| * <td>(no C API)</td> |
| * <td>icu::AlphabeticIndex</td> |
| * </tr> |
| * <tr> |
| * <td>Text Boundary Analysis<br/>(Break Iteration)</td> |
| * <td>ubrk.h</td> |
| * <td>icu::BreakIterator</td> |
| * </tr> |
| * <tr> |
| * <td>Regular Expressions</td> |
| * <td>uregex.h</td> |
| * <td>icu::RegexPattern, icu::RegexMatcher</td> |
| * </tr> |
| * <tr> |
| * <td>StringPrep</td> |
| * <td>usprep.h</td> |
| * <td>C API</td> |
| * </tr> |
| * <tr> |
| * <td>International Domain Names in Applications:<br/> |
| * UTS #46 in C/C++, IDNA2003 only via C API</td> |
| * <td>uidna.h</td> |
| * <td>idna.h</td> |
| * </tr> |
| * <tr> |
| * <td>Identifier Spoofing & Confusability</td> |
| * <td>uspoof.h</td> |
| * <td>C API</td> |
| * <tr> |
| * <td>Universal Time Scale</td> |
| * <td>utmscale.h</td> |
| * <td>C API</td> |
| * </tr> |
| * <tr> |
| * <td>Paragraph Layout / Complex Text Layout</td> |
| * <td>playout.h</td> |
| * <td>icu::ParagraphLayout</td> |
| * </tr> |
| * <tr> |
| * <td>ICU I/O</td> |
| * <td>ustdio.h</td> |
| * <td>ustream.h</td> |
| * </tr> |
| * </table> |
| * <i>This main page is generated from docmain.h</i> |
| */ |
