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