ICU-511.25.tar.gz

[apple/icu.git] / icuSources / common / unicode / docmain.h

diff --git a/icuSources/common/unicode/docmain.h b/icuSources/common/unicode/docmain.h
index 05653161f22def2639938a432291ab0c26e6bf35..df3fe842aacf1ddeeb1ec77e1b2d40e3ae5f7576 100644 (file)
--- a/icuSources/common/unicode/docmain.h
+++ b/icuSources/common/unicode/docmain.h
@@ -1,6 +1,6 @@
 /********************************************************************
  * COPYRIGHT: 
- * Copyright (c) 1997-2011, International Business Machines Corporation and
+ * Copyright (c) 1997-2012, International Business Machines Corporation and
  * others. All Rights Reserved.
  *
  *  FILE NAME: DOCMAIN.h
@@ -9,7 +9,11 @@
  *   12/11/2000    Ram        Creation.
  */
 
-/* This file contains documentation for Doxygen and doesnot have
+/**
+ * \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
  */
 
@@ -69,22 +73,22 @@
  *   <tr>
  *     <td>Strings and Character Iteration</td>
  *     <td>ustring.h, utf8.h, utf16.h, UText, UCharIterator</td>
- *     <td>UnicodeString, CharacterIterator, Appendable, StringPiece, ByteSink</td>
+ *     <td>icu::UnicodeString, icu::CharacterIterator, icu::Appendable, icu::StringPiece,icu::ByteSink</td>
  *   </tr>
  *   <tr>
- *     <td>Unicode Character<br>Properties and Names</td>
+ *     <td>Unicode Character<br/>Properties and Names</td>
  *     <td>uchar.h, uscript.h</td>
  *     <td>C API</td>
  *   </tr>
  *   <tr>
  *     <td>Sets of Unicode Code Points and Strings</td>
  *     <td>uset.h</td>
- *     <td>UnicodeSet</td>
+ *     <td>icu::UnicodeSet</td>
  *   </tr>
  *   <tr>
  *     <td>Maps from Strings to Integer Values</td>
  *     <td>(no C API)</td>
- *     <td>BytesTrie, UCharsTrie</td>
+ *     <td>icu::BytesTrie, icu::UCharsTrie</td>
  *   </tr>
  *   <tr>
  *     <td>Codepage Conversion</td>
@@ -93,53 +97,53 @@
  *   </tr>
  *   <tr>
  *     <td>Unicode Text Compression</td>
- *     <td>ucnv.h<br>(encoding name "SCSU" or "BOCU-1")</td>
+ *     <td>ucnv.h<br/>(encoding name "SCSU" or "BOCU-1")</td>
  *     <td>C API</td>
  *   </tr>
  *   <tr>
  *     <td>Locales </td>
  *     <td>uloc.h</a></td>
- *     <td>Locale</td>
+ *     <td>icu::Locale</td>
  *   </tr>
  *   <tr>
  *     <td>Resource Bundles</td>
  *     <td>ures.h</td>
- *     <td>ResourceBundle</td>
+ *     <td>icu::ResourceBundle</td>
  *   </tr>
  *   <tr>
  *     <td>Normalization</td>
  *     <td>unorm2.h</td>
- *     <td>Normalizer2</td>
+ *     <td>icu::Normalizer2</td>
  *   </tr>
  *   <tr>
  *     <td>Calendars</td>
  *     <td>ucal.h</td>
- *     <td>Calendar</td>
+ *     <td>icu::Calendar</td>
  *   </tr>
  *   <tr>
  *     <td>Date and Time Formatting</td>
  *     <td>udat.h</td>
- *     <td>DateFormat</td>
+ *     <td>icu::DateFormat</td>
  *   </tr>
  *   <tr>
  *     <td>Message Formatting</td>
  *     <td>umsg.h</td>
- *     <td>MessageFormat</td>
+ *     <td>icu::MessageFormat</td>
  *   </tr>
  *   <tr>
  *     <td>Number Formatting</td>
  *     <td>unum.h</td>
- *     <td>NumberFormat</td>
+ *     <td>icu::NumberFormat</td>
  *   </tr>
  *   <tr>
- *     <td>Number Spellout<br>(Rule Based Number Formatting)</td>
- *     <td>unum.h<br>(use UNUM_SPELLOUT)</td>
- *     <td>RuleBasedNumberFormat</td>
+ *     <td>Number Spellout<br/>(Rule Based Number Formatting)</td>
+ *     <td>unum.h<br/>(use UNUM_SPELLOUT)</td>
+ *     <td>icu::RuleBasedNumberFormat</td>
  *   </tr>
  *   <tr>
- *     <td>Text Transformation<br>(Transliteration)</td>
+ *     <td>Text Transformation<br/>(Transliteration)</td>
  *     <td>utrans.h</td>
- *     <td>Transliterator</td>
+ *     <td>icu::Transliterator</td>
  *   </tr>
  *   <tr>
  *     <td>Bidirectional Algorithm</td>
@@ -154,27 +158,27 @@
  *   <tr>
  *     <td>Collation</td>
  *     <td>ucol.h</td>
- *     <td>Collator</td>
+ *     <td>icu::Collator</td>
  *   </tr>
  *   <tr>
  *     <td>String Searching</td>
  *     <td>usearch.h</td>
- *     <td>StringSearch</td>
+ *     <td>icu::StringSearch</td>
  *   </tr>
  *   <tr>
- *     <td>Index Characters/<br>Bucketing for Sorted Lists</td>
+ *     <td>Index Characters/<br/>Bucketing for Sorted Lists</td>
  *     <td>(no C API)</td>
- *     <td>AlphabeticIndex</td>
+ *     <td>icu::AlphabeticIndex</td>
  *   </tr>
  *   <tr>
- *     <td>Text Boundary Analysis<br>(Break Iteration)</td>
+ *     <td>Text Boundary Analysis<br/>(Break Iteration)</td>
  *     <td>ubrk.h</td>
- *     <td>BreakIterator</td>
+ *     <td>icu::BreakIterator</td>
  *   </tr>
  *   <tr>
  *     <td>Regular Expressions</td>
  *     <td>uregex.h</td>
- *     <td>RegexPattern, RegexMatcher</td>
+ *     <td>icu::RegexPattern, icu::RegexMatcher</td>
  *   </tr>
  *   <tr>
  *     <td>StringPrep</td>
@@ -182,7 +186,7 @@
  *     <td>C API</td>
  *   </tr>
  *   <tr>
- *     <td>International Domain Names in Applications:<br>
+ *     <td>International Domain Names in Applications:<br/>
  *         UTS #46 in C/C++, IDNA2003 only via C API</td>
  *     <td>uidna.h</td>
  *     <td>idna.h</td>
@@ -199,7 +203,7 @@
  *   <tr>
  *     <td>Layout Engine/Complex Text Layout</td>
  *     <td>loengine.h</td>
- *     <td>LayoutEngine, ParagraphLayout</td>
+ *     <td>icu::LayoutEngine,icu::ParagraphLayout</td>
  *   </tr>
  *   <tr>
  *     <td>ICU I/O</td>