icuSources/common/unicode/docmain.h

   1 /********************************************************************
   2  * COPYRIGHT:
   3  * Copyright (c) 1997-2003, International Business Machines Corporation and
   4  * others. All Rights Reserved.
   5  *
   6  *  FILE NAME: DOCMAIN.h
   7  *
   8  *   Date          Name        Description
   9  *   12/11/2000    Ram        Creation.
  10  */
  11
  12 /* This file contains documentation for Doxygen and doesnot have
  13  * any significance with respect to C or C++ API
  14  */
  15
  16 /*! \mainpage
  17  *
  18  * \section Usage
  19  * <h2>API Reference Usage</h2>
  20  *
  21  * <h3>C++ Programmers:</h3>
  22  * <p>Use  <a href="hierarchy.html">Class Hierarchy</a> or <a href="classes.html> Alphabetical List </a>
  23  * or <a href="annotated.html"> Compound List</a>
  24  * to find the class you are interested in. For example, to find BreakIterator,
  25  * you can go to the <a href="classes.html"> Alphabetical List</a>, then click on
  26  * "BreakIterator". Once you are at the class, you will find an inheritance
  27  * chart, a list of the public members, a detailed description of the class,
  28  * then detailed member descriptions.</p>
  29  *
  30  * <h3>C Programmers:</h3>
  31  * <p>Use <a href="#Module">Module List</a> or <a href="globals.html"> File Members</a>
  32  * to find a list of all the functions and constants.
  33  * For example, to find BreakIterator functions you would click on
  34  * <a href="files.html"> File List</a>,
  35  * then find "ubrk.h" and click on it. You will find descriptions of Defines,
  36  * Typedefs, Enumerations, and Functions, with detailed descriptions below.
  37  * If you want to find a specific function, such as ubrk_next(), then click
  38  * first on <a href="globals.html"> File Members</a>, then use your browser
  39  * Find dialog to search for "ubrk_next()".</p>
  40  *
  41  *
  42  * <h3>API References for Previous Releases</h3>
  43  * <p>The API References for the previous release are available
  44  *   <a href="http://oss.software.ibm.com/icu/apiref/previous/">online</a>.
  45  *   For each release there are also .zip and .tgz files for the API References
  46  *   on the <a href="http://oss.software.ibm.com/icu/download/">download page</a> of the release.</p>
  47  *
  48  * <hr>
  49  *
  50  * <h2>Architecture (User's Guide)</h2>
  51  * <ul>
  52  *   <li><a href="http://oss.software.ibm.com/icu/userguide/index.html">Introduction</a></li>
  53  *   <li><a href="http://oss.software.ibm.com/icu/userguide/i18n.html">Internationalization</a></li>
  54  *   <li><a href="http://oss.software.ibm.com/icu/userguide/design.html">Locale Model</a></li>
  55  *   <li><a href="http://oss.software.ibm.com/icu/userguide/design.html">Multithreading</a></li>
  56  *   <li><a href="http://oss.software.ibm.com/icu/userguide/conversion.html">Conversion</a></li>
  57  *   <li><a href="http://oss.software.ibm.com/icu/userguide/design.html">Error Handling</a></li>
  58  * </ul>
  59  *
  60  * <hr>
  61  *
  62  * <h2><a name="Module">Module List</a></h2>
  63  * <table border="1" cols="3" align="center">
  64  *   <tr>
  65  *     <td><strong>Module Name</strong></td>
  66  *     <td><strong>C</strong></td>
  67  *     <td><strong>C++</strong></td>
  68  *   </tr>
  69  *   <tr>
  70  *     <td>Basic Types and Constants</td>
  71  *     <td>utypes.h</td>
  72  *     <td>utypes.h</td>
  73  *   </tr>
  74  *   <tr>
  75  *     <td>Strings and Character Iteration</td>
  76  *     <td>ustring.h, utf.h</td>
  77  *     <td>UnicodeString, CharacterIterator</td>
  78  *   </tr>
  79  *   <tr>
  80  *     <td>Unicode Character<br>Properties and Names</td>
  81  *     <td>uchar.h</td>
  82  *     <td>uchar.h C API</td>
  83  *   </tr>
  84  *   <tr>
  85  *     <td>Codepage Conversion</td>
  86  *     <td>ucnv.h</td>
  87  *     <td>ucnv.h C API</td>
  88  *   </tr>
  89  *   <tr>
  90  *     <td>Unicode Text Compression</td>
  91  *     <td>ucnv.h<br>(encoding name "SCSU" or "BOCU-1")</td>
  92  *     <td>ucnv.h C API</td>
  93  *   </tr>
  94  *   <tr>
  95  *     <td>Locales </td>
  96  *     <td>uloc.h</a></td>
  97  *     <td>Locale</td>
  98  *   </tr>
  99  *   <tr>
 100  *     <td>Resource Bundles</td>
 101  *     <td>ures.h</td>
 102  *     <td>ResourceBundle</td>
 103  *   </tr>
 104  *   <tr>
 105  *     <td>Normalization</td>
 106  *     <td>unorm.h</td>
 107  *     <td>Normalizer</td>
 108  *   </tr>
 109  *   <tr>
 110  *     <td>Calendars</td>
 111  *     <td>ucal.h</td>
 112  *     <td>Calendar</td>
 113  *   </tr>
 114  *   <tr>
 115  *     <td>Date and Time Formatting</td>
 116  *     <td>udat.h</td>
 117  *     <td>DateFormat</td>
 118  *   </tr>
 119  *   <tr>
 120  *     <td>Message Formatting</td>
 121  *     <td>umsg.h</td>
 122  *     <td>MessageFormat</td>
 123  *   </tr>
 124  *   <tr>
 125  *     <td>Number Formatting</td>
 126  *     <td>unum.h</td>
 127  *     <td>NumberFormat</td>
 128  *   </tr>
 129  *   <tr>
 130  *     <td>Number Spellout<br>(Rule Based Number Formatting)</td>
 131  *     <td>unum.h<br>(use UNUM_SPELLOUT)</td>
 132  *     <td>RuleBasedNumberFormat</td>
 133  *   </tr>
 134  *   <tr>
 135  *     <td>Text Transformation<br>(Transliteration)</td>
 136  *     <td>utrans.h</td>
 137  *     <td>Transliterator</td>
 138  *   </tr>
 139  *   <tr>
 140  *     <td>Bidirectional Algorithm</td>
 141  *     <td>ubidi.h</td>
 142  *     <td>ubidi.h C API</td>
 143  *   </tr>
 144  *   <tr>
 145  *     <td>Arabic Shaping</td>
 146  *     <td>ushape.h</td>
 147  *     <td>ushape.h C API</td>
 148  *   </tr>
 149  *   <tr>
 150  *     <td>Collation</td>
 151  *     <td>ucol.h</td>
 152  *     <td>Collator</td>
 153  *   </tr>
 154  *   <tr>
 155  *     <td>String Searching</td>
 156  *     <td>usearch.h</td>
 157  *     <td>StringSearch</td>
 158  *   </tr>
 159  *   <tr>
 160  *     <td>Text Boundary Analysis<br>(Break Iteration)</td>
 161  *     <td>ubrk.h</td>
 162  *     <td>BreakIterator</td>
 163  *   </tr>
 164  *   <tr>
 165  *     <td>Unicode Set</td>
 166  *     <td>uset.h</td>
 167  *     <td>UnicodeSet</td>
 168  *   </tr>
 169  *   <tr>
 170  *     <td>Regular Expressions</td>
 171  *     <td>N/A</td>
 172  *     <td>RegexPattern, RegexMatcher</td>
 173  *   </tr>
 174  * </table>
 175  */