<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>docmain.h</title>
<style type="text/css">
.enscript-comment { font-style: italic; color: rgb(178,34,34); }
.enscript-function-name { font-weight: bold; color: rgb(0,0,255); }
.enscript-variable-name { font-weight: bold; color: rgb(184,134,11); }
.enscript-keyword { font-weight: bold; color: rgb(160,32,240); }
.enscript-reference { font-weight: bold; color: rgb(95,158,160); }
.enscript-string { font-weight: bold; color: rgb(188,143,143); }
.enscript-builtin { font-weight: bold; color: rgb(218,112,214); }
.enscript-type { font-weight: bold; color: rgb(34,139,34); }
.enscript-highlight { text-decoration: underline; color: 0; }
</style>
</head>
<body id="top">
<h1 style="margin:8px;" id="f1">docmain.h&nbsp;&nbsp;&nbsp;<span style="font-weight: normal; font-size: 0.5em;">[<a href="docmain.h">plain text</a>]</span></h1>
<hr/>
<div></div>
<pre>
<span class="enscript-comment">/********************************************************************
 * 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.
 */</span>

<span class="enscript-comment">/**
 * \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
 */</span>

<span class="enscript-comment">/*! \mainpage
 *
 * \section API API Reference Usage
 * 
 * &lt;h3&gt;C++ Programmers:&lt;/h3&gt;
 * &lt;p&gt;Use &lt;a href=&quot;hierarchy.html&quot;&gt;Class Hierarchy&lt;/a&gt; or &lt;a href=&quot;classes.html&quot;&gt; Alphabetical List &lt;/a&gt;
 * or &lt;a href=&quot;annotated.html&quot;&gt; Compound List&lt;/a&gt;
 * to find the class you are interested in. For example, to find BreakIterator,
 * you can go to the &lt;a href=&quot;classes.html&quot;&gt; Alphabetical List&lt;/a&gt;, then click on
 * &quot;BreakIterator&quot;. 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.&lt;/p&gt;
 * 
 * &lt;h3&gt;C Programmers:&lt;/h3&gt;
 * &lt;p&gt;Use &lt;a href=&quot;#Module&quot;&gt;Module List&lt;/a&gt; or &lt;a href=&quot;globals.html&quot;&gt;File Members&lt;/a&gt;
 * to find a list of all the functions and constants.
 * For example, to find BreakIterator functions you would click on
 * &lt;a href=&quot;files.html&quot;&gt; File List&lt;/a&gt;,
 * then find &quot;ubrk.h&quot; 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 &lt;a href=&quot;globals.html&quot;&gt; File Members&lt;/a&gt;, then use your browser
 * Find dialog to search for &quot;ubrk_next()&quot;.&lt;/p&gt;
 *
 *
 * &lt;h3&gt;API References for Previous Releases&lt;/h3&gt;
 * &lt;p&gt;The API References for each release of ICU are also available as
 * a zip file from the ICU 
 * &lt;a href=&quot;<a href="http://site.icu-project.org/download">http://site.icu-project.org/download</a>&quot;&gt;download page&lt;/a&gt;.&lt;/p&gt;
 *
 * &lt;hr&gt;
 *
 * &lt;h2&gt;Architecture (User's Guide)&lt;/h2&gt;
 * &lt;ul&gt;
 *   &lt;li&gt;&lt;a href=&quot;<a href="http://userguide.icu-project.org/">http://userguide.icu-project.org/</a>&quot;&gt;Introduction&lt;/a&gt;&lt;/li&gt;
 *   &lt;li&gt;&lt;a href=&quot;<a href="http://userguide.icu-project.org/i18n">http://userguide.icu-project.org/i18n</a>&quot;&gt;Internationalization&lt;/a&gt;&lt;/li&gt;
 *   &lt;li&gt;&lt;a href=&quot;<a href="http://userguide.icu-project.org/design">http://userguide.icu-project.org/design</a>&quot;&gt;Locale Model, Multithreading, Error Handling, etc.&lt;/a&gt;&lt;/li&gt;
 *   &lt;li&gt;&lt;a href=&quot;<a href="http://userguide.icu-project.org/conversion">http://userguide.icu-project.org/conversion</a>&quot;&gt;Conversion&lt;/a&gt;&lt;/li&gt;
 * &lt;/ul&gt;
 *
 * &lt;hr&gt;
 *\htmlonly &lt;h2&gt;&lt;a NAME=&quot;Module&quot;&gt;Module List&lt;/a&gt;&lt;/h2&gt; \endhtmlonly
 * &lt;table border=&quot;1&quot; cols=&quot;3&quot; align=&quot;center&quot;&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;&lt;strong&gt;Module Name&lt;/strong&gt;&lt;/td&gt;
 *     &lt;td&gt;&lt;strong&gt;C&lt;/strong&gt;&lt;/td&gt;
 *     &lt;td&gt;&lt;strong&gt;C++&lt;/strong&gt;&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Basic Types and Constants&lt;/td&gt;
 *     &lt;td&gt;utypes.h&lt;/td&gt;
 *     &lt;td&gt;utypes.h&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Strings and Character Iteration&lt;/td&gt;
 *     &lt;td&gt;ustring.h, utf8.h, utf16.h, UText, UCharIterator&lt;/td&gt;
 *     &lt;td&gt;icu::UnicodeString, icu::CharacterIterator, icu::Appendable, icu::StringPiece,icu::ByteSink&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Unicode Character&lt;br/&gt;Properties and Names&lt;/td&gt;
 *     &lt;td&gt;uchar.h, uscript.h&lt;/td&gt;
 *     &lt;td&gt;C API&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Sets of Unicode Code Points and Strings&lt;/td&gt;
 *     &lt;td&gt;uset.h&lt;/td&gt;
 *     &lt;td&gt;icu::UnicodeSet&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Maps from Strings to Integer Values&lt;/td&gt;
 *     &lt;td&gt;(no C API)&lt;/td&gt;
 *     &lt;td&gt;icu::BytesTrie, icu::UCharsTrie&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Codepage Conversion&lt;/td&gt;
 *     &lt;td&gt;ucnv.h, ucnvsel.hb&lt;/td&gt;
 *     &lt;td&gt;C API&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Unicode Text Compression&lt;/td&gt;
 *     &lt;td&gt;ucnv.h&lt;br/&gt;(encoding name &quot;SCSU&quot; or &quot;BOCU-1&quot;)&lt;/td&gt;
 *     &lt;td&gt;C API&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Locales &lt;/td&gt;
 *     &lt;td&gt;uloc.h&lt;/a&gt;&lt;/td&gt;
 *     &lt;td&gt;icu::Locale&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Resource Bundles&lt;/td&gt;
 *     &lt;td&gt;ures.h&lt;/td&gt;
 *     &lt;td&gt;icu::ResourceBundle&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Normalization&lt;/td&gt;
 *     &lt;td&gt;unorm2.h&lt;/td&gt;
 *     &lt;td&gt;icu::Normalizer2&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Calendars&lt;/td&gt;
 *     &lt;td&gt;ucal.h&lt;/td&gt;
 *     &lt;td&gt;icu::Calendar&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Date and Time Formatting&lt;/td&gt;
 *     &lt;td&gt;udat.h&lt;/td&gt;
 *     &lt;td&gt;icu::DateFormat&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Message Formatting&lt;/td&gt;
 *     &lt;td&gt;umsg.h&lt;/td&gt;
 *     &lt;td&gt;icu::MessageFormat&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Number Formatting&lt;/td&gt;
 *     &lt;td&gt;unum.h&lt;/td&gt;
 *     &lt;td&gt;icu::NumberFormat&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Number Spellout&lt;br/&gt;(Rule Based Number Formatting)&lt;/td&gt;
 *     &lt;td&gt;unum.h&lt;br/&gt;(use UNUM_SPELLOUT)&lt;/td&gt;
 *     &lt;td&gt;icu::RuleBasedNumberFormat&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Text Transformation&lt;br/&gt;(Transliteration)&lt;/td&gt;
 *     &lt;td&gt;utrans.h&lt;/td&gt;
 *     &lt;td&gt;icu::Transliterator&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Bidirectional Algorithm&lt;/td&gt;
 *     &lt;td&gt;ubidi.h&lt;/td&gt;
 *     &lt;td&gt;C API&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Arabic Shaping&lt;/td&gt;
 *     &lt;td&gt;ushape.h&lt;/td&gt;
 *     &lt;td&gt;C API&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Collation&lt;/td&gt;
 *     &lt;td&gt;ucol.h&lt;/td&gt;
 *     &lt;td&gt;icu::Collator&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;String Searching&lt;/td&gt;
 *     &lt;td&gt;usearch.h&lt;/td&gt;
 *     &lt;td&gt;icu::StringSearch&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Index Characters/&lt;br/&gt;Bucketing for Sorted Lists&lt;/td&gt;
 *     &lt;td&gt;(no C API)&lt;/td&gt;
 *     &lt;td&gt;icu::AlphabeticIndex&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Text Boundary Analysis&lt;br/&gt;(Break Iteration)&lt;/td&gt;
 *     &lt;td&gt;ubrk.h&lt;/td&gt;
 *     &lt;td&gt;icu::BreakIterator&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Regular Expressions&lt;/td&gt;
 *     &lt;td&gt;uregex.h&lt;/td&gt;
 *     &lt;td&gt;icu::RegexPattern, icu::RegexMatcher&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;StringPrep&lt;/td&gt;
 *     &lt;td&gt;usprep.h&lt;/td&gt;
 *     &lt;td&gt;C API&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;International Domain Names in Applications:&lt;br/&gt;
 *         UTS #46 in C/C++, IDNA2003 only via C API&lt;/td&gt;
 *     &lt;td&gt;uidna.h&lt;/td&gt;
 *     &lt;td&gt;idna.h&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Identifier Spoofing &amp; Confusability&lt;/td&gt;
 *     &lt;td&gt;uspoof.h&lt;/td&gt;
 *     &lt;td&gt;C API&lt;/td&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Universal Time Scale&lt;/td&gt;
 *     &lt;td&gt;utmscale.h&lt;/td&gt;
 *     &lt;td&gt;C API&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;Layout Engine/Complex Text Layout&lt;/td&gt;
 *     &lt;td&gt;loengine.h&lt;/td&gt;
 *     &lt;td&gt;icu::LayoutEngine,icu::ParagraphLayout&lt;/td&gt;
 *   &lt;/tr&gt;
 *   &lt;tr&gt;
 *     &lt;td&gt;ICU I/O&lt;/td&gt;
 *     &lt;td&gt;ustdio.h&lt;/td&gt;
 *     &lt;td&gt;ustream.h&lt;/td&gt;
 *   &lt;/tr&gt;
 * &lt;/table&gt;
 * &lt;i&gt;This main page is generated from docmain.h&lt;/i&gt;
 */</span>
</pre>
<hr />
</body></html>