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