1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/intl/icu/source/common/unicode/docmain.h Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,215 @@
1.4 +/********************************************************************
1.5 + * COPYRIGHT:
1.6 + * Copyright (c) 1997-2012, International Business Machines Corporation and
1.7 + * others. All Rights Reserved.
1.8 + *
1.9 + * FILE NAME: DOCMAIN.h
1.10 + *
1.11 + * Date Name Description
1.12 + * 12/11/2000 Ram Creation.
1.13 + */
1.14 +
1.15 +/**
1.16 + * \file
1.17 + * \brief (Non API- contains Doxygen definitions)
1.18 + *
1.19 + * This file contains documentation for Doxygen and doesnot have
1.20 + * any significance with respect to C or C++ API
1.21 + */
1.22 +
1.23 +/*! \mainpage
1.24 + *
1.25 + * \section API API Reference Usage
1.26 + *
1.27 + * <h3>C++ Programmers:</h3>
1.28 + * <p>Use <a href="hierarchy.html">Class Hierarchy</a> or <a href="classes.html"> Alphabetical List </a>
1.29 + * or <a href="annotated.html"> Compound List</a>
1.30 + * to find the class you are interested in. For example, to find BreakIterator,
1.31 + * you can go to the <a href="classes.html"> Alphabetical List</a>, then click on
1.32 + * "BreakIterator". Once you are at the class, you will find an inheritance
1.33 + * chart, a list of the public members, a detailed description of the class,
1.34 + * then detailed member descriptions.</p>
1.35 + *
1.36 + * <h3>C Programmers:</h3>
1.37 + * <p>Use <a href="#Module">Module List</a> or <a href="globals.html">File Members</a>
1.38 + * to find a list of all the functions and constants.
1.39 + * For example, to find BreakIterator functions you would click on
1.40 + * <a href="files.html"> File List</a>,
1.41 + * then find "ubrk.h" and click on it. You will find descriptions of Defines,
1.42 + * Typedefs, Enumerations, and Functions, with detailed descriptions below.
1.43 + * If you want to find a specific function, such as ubrk_next(), then click
1.44 + * first on <a href="globals.html"> File Members</a>, then use your browser
1.45 + * Find dialog to search for "ubrk_next()".</p>
1.46 + *
1.47 + *
1.48 + * <h3>API References for Previous Releases</h3>
1.49 + * <p>The API References for each release of ICU are also available as
1.50 + * a zip file from the ICU
1.51 + * <a href="http://site.icu-project.org/download">download page</a>.</p>
1.52 + *
1.53 + * <hr>
1.54 + *
1.55 + * <h2>Architecture (User's Guide)</h2>
1.56 + * <ul>
1.57 + * <li><a href="http://userguide.icu-project.org/">Introduction</a></li>
1.58 + * <li><a href="http://userguide.icu-project.org/i18n">Internationalization</a></li>
1.59 + * <li><a href="http://userguide.icu-project.org/design">Locale Model, Multithreading, Error Handling, etc.</a></li>
1.60 + * <li><a href="http://userguide.icu-project.org/conversion">Conversion</a></li>
1.61 + * </ul>
1.62 + *
1.63 + * <hr>
1.64 + *\htmlonly <h2><a NAME="Module">Module List</a></h2> \endhtmlonly
1.65 + * <table border="1" cols="3" align="center">
1.66 + * <tr>
1.67 + * <td><strong>Module Name</strong></td>
1.68 + * <td><strong>C</strong></td>
1.69 + * <td><strong>C++</strong></td>
1.70 + * </tr>
1.71 + * <tr>
1.72 + * <td>Basic Types and Constants</td>
1.73 + * <td>utypes.h</td>
1.74 + * <td>utypes.h</td>
1.75 + * </tr>
1.76 + * <tr>
1.77 + * <td>Strings and Character Iteration</td>
1.78 + * <td>ustring.h, utf8.h, utf16.h, UText, UCharIterator</td>
1.79 + * <td>icu::UnicodeString, icu::CharacterIterator, icu::Appendable, icu::StringPiece,icu::ByteSink</td>
1.80 + * </tr>
1.81 + * <tr>
1.82 + * <td>Unicode Character<br/>Properties and Names</td>
1.83 + * <td>uchar.h, uscript.h</td>
1.84 + * <td>C API</td>
1.85 + * </tr>
1.86 + * <tr>
1.87 + * <td>Sets of Unicode Code Points and Strings</td>
1.88 + * <td>uset.h</td>
1.89 + * <td>icu::UnicodeSet</td>
1.90 + * </tr>
1.91 + * <tr>
1.92 + * <td>Maps from Strings to Integer Values</td>
1.93 + * <td>(no C API)</td>
1.94 + * <td>icu::BytesTrie, icu::UCharsTrie</td>
1.95 + * </tr>
1.96 + * <tr>
1.97 + * <td>Codepage Conversion</td>
1.98 + * <td>ucnv.h, ucnvsel.hb</td>
1.99 + * <td>C API</td>
1.100 + * </tr>
1.101 + * <tr>
1.102 + * <td>Unicode Text Compression</td>
1.103 + * <td>ucnv.h<br/>(encoding name "SCSU" or "BOCU-1")</td>
1.104 + * <td>C API</td>
1.105 + * </tr>
1.106 + * <tr>
1.107 + * <td>Locales </td>
1.108 + * <td>uloc.h</a></td>
1.109 + * <td>icu::Locale</td>
1.110 + * </tr>
1.111 + * <tr>
1.112 + * <td>Resource Bundles</td>
1.113 + * <td>ures.h</td>
1.114 + * <td>icu::ResourceBundle</td>
1.115 + * </tr>
1.116 + * <tr>
1.117 + * <td>Normalization</td>
1.118 + * <td>unorm2.h</td>
1.119 + * <td>icu::Normalizer2</td>
1.120 + * </tr>
1.121 + * <tr>
1.122 + * <td>Calendars</td>
1.123 + * <td>ucal.h</td>
1.124 + * <td>icu::Calendar</td>
1.125 + * </tr>
1.126 + * <tr>
1.127 + * <td>Date and Time Formatting</td>
1.128 + * <td>udat.h</td>
1.129 + * <td>icu::DateFormat</td>
1.130 + * </tr>
1.131 + * <tr>
1.132 + * <td>Message Formatting</td>
1.133 + * <td>umsg.h</td>
1.134 + * <td>icu::MessageFormat</td>
1.135 + * </tr>
1.136 + * <tr>
1.137 + * <td>Number Formatting</td>
1.138 + * <td>unum.h</td>
1.139 + * <td>icu::NumberFormat</td>
1.140 + * </tr>
1.141 + * <tr>
1.142 + * <td>Number Spellout<br/>(Rule Based Number Formatting)</td>
1.143 + * <td>unum.h<br/>(use UNUM_SPELLOUT)</td>
1.144 + * <td>icu::RuleBasedNumberFormat</td>
1.145 + * </tr>
1.146 + * <tr>
1.147 + * <td>Text Transformation<br/>(Transliteration)</td>
1.148 + * <td>utrans.h</td>
1.149 + * <td>icu::Transliterator</td>
1.150 + * </tr>
1.151 + * <tr>
1.152 + * <td>Bidirectional Algorithm</td>
1.153 + * <td>ubidi.h</td>
1.154 + * <td>C API</td>
1.155 + * </tr>
1.156 + * <tr>
1.157 + * <td>Arabic Shaping</td>
1.158 + * <td>ushape.h</td>
1.159 + * <td>C API</td>
1.160 + * </tr>
1.161 + * <tr>
1.162 + * <td>Collation</td>
1.163 + * <td>ucol.h</td>
1.164 + * <td>icu::Collator</td>
1.165 + * </tr>
1.166 + * <tr>
1.167 + * <td>String Searching</td>
1.168 + * <td>usearch.h</td>
1.169 + * <td>icu::StringSearch</td>
1.170 + * </tr>
1.171 + * <tr>
1.172 + * <td>Index Characters/<br/>Bucketing for Sorted Lists</td>
1.173 + * <td>(no C API)</td>
1.174 + * <td>icu::AlphabeticIndex</td>
1.175 + * </tr>
1.176 + * <tr>
1.177 + * <td>Text Boundary Analysis<br/>(Break Iteration)</td>
1.178 + * <td>ubrk.h</td>
1.179 + * <td>icu::BreakIterator</td>
1.180 + * </tr>
1.181 + * <tr>
1.182 + * <td>Regular Expressions</td>
1.183 + * <td>uregex.h</td>
1.184 + * <td>icu::RegexPattern, icu::RegexMatcher</td>
1.185 + * </tr>
1.186 + * <tr>
1.187 + * <td>StringPrep</td>
1.188 + * <td>usprep.h</td>
1.189 + * <td>C API</td>
1.190 + * </tr>
1.191 + * <tr>
1.192 + * <td>International Domain Names in Applications:<br/>
1.193 + * UTS #46 in C/C++, IDNA2003 only via C API</td>
1.194 + * <td>uidna.h</td>
1.195 + * <td>idna.h</td>
1.196 + * </tr>
1.197 + * <tr>
1.198 + * <td>Identifier Spoofing & Confusability</td>
1.199 + * <td>uspoof.h</td>
1.200 + * <td>C API</td>
1.201 + * <tr>
1.202 + * <td>Universal Time Scale</td>
1.203 + * <td>utmscale.h</td>
1.204 + * <td>C API</td>
1.205 + * </tr>
1.206 + * <tr>
1.207 + * <td>Layout Engine/Complex Text Layout</td>
1.208 + * <td>loengine.h</td>
1.209 + * <td>icu::LayoutEngine,icu::ParagraphLayout</td>
1.210 + * </tr>
1.211 + * <tr>
1.212 + * <td>ICU I/O</td>
1.213 + * <td>ustdio.h</td>
1.214 + * <td>ustream.h</td>
1.215 + * </tr>
1.216 + * </table>
1.217 + * <i>This main page is generated from docmain.h</i>
1.218 + */
