ICU-647 Updated documentation in the header files
X-SVN-Rev: 3240
diff --git a/icu4c/source/common/unicode/normlzr.h b/icu4c/source/common/unicode/normlzr.h
index 32d43d2..e35594a 100644
--- a/icu4c/source/common/unicode/normlzr.h
+++ b/icu4c/source/common/unicode/normlzr.h
@@ -300,7 +300,7 @@
* Currently the only available option is {@link #IGNORE_HANGUL}
* If you want the default behavior corresponding to one of the
* standard Unicode Normalization Forms, use 0 for this argument
- * @add
+ * @unimplemented
*
*/
Normalizer(const UChar* str,
@@ -680,7 +680,7 @@
/**
* Returns the text under iteration into the UChar* buffer pointer.
* @param result Receives a copy of the text under iteration.
- * @add
+ * @unimplemented
*/
const UChar* getText(int32_t& count);
diff --git a/icu4c/source/common/unicode/scsu.h b/icu4c/source/common/unicode/scsu.h
index 9f21db1..f011ea3 100644
--- a/icu4c/source/common/unicode/scsu.h
+++ b/icu4c/source/common/unicode/scsu.h
@@ -24,9 +24,10 @@
/**
* \file
- * \brief Description of Standard Compression for Unicode C API
+ * \brief C API: Standard Compression for Unicode
*
* <h2> Standard Compression for Unicode </h2>
+ * @deprecated To be replaced by scsu encoding converter
*/
/* Number of windows */
@@ -73,6 +74,7 @@
* Sets all windows to their default values.
* @see #reset
* @stable
+ * @deprecated To be replaced by scsu encoding converter
*/
U_CAPI void U_EXPORT2 scsu_init(UnicodeCompressor *comp);
@@ -80,6 +82,7 @@
* Reset the compressor to its initial state.
* @param comp The UnicodeCompressor to reset.
* @stable
+ * @deprecated To be replaced by scsu encoding converter
*/
U_CAPI void U_EXPORT2 scsu_reset(UnicodeCompressor *comp);
@@ -108,6 +111,7 @@
*
* @see #decompress
* @stable
+ * @deprecated To be replaced by scsu encoding converter
*/
U_CAPI void U_EXPORT2 scsu_compress(UnicodeCompressor *comp,
uint8_t **target,
@@ -143,6 +147,7 @@
*
* @see #compress
* @stable
+ * @deprecated To be replaced by scsu encoding converter
*/
U_CAPI void U_EXPORT2 scsu_decompress(UnicodeCompressor *comp,
UChar **target,
diff --git a/icu4c/source/common/unicode/ubidi.h b/icu4c/source/common/unicode/ubidi.h
index e027e64..b81b86d 100644
--- a/icu4c/source/common/unicode/ubidi.h
+++ b/icu4c/source/common/unicode/ubidi.h
@@ -36,7 +36,7 @@
/**
*\file
- * \brief Description of BIDI algorithm for ICU C API
+ * \brief C API: BIDI algorithm
*
* <h2>BIDI algorithm for ICU</h2>
*
diff --git a/icu4c/source/common/unicode/uchar.h b/icu4c/source/common/unicode/uchar.h
index b372517..bf18f40 100644
--- a/icu4c/source/common/unicode/uchar.h
+++ b/icu4c/source/common/unicode/uchar.h
@@ -31,7 +31,7 @@
/**
* \file
- * \brief Description of ICU's Unicode Char C API
+ * \brief C API: Unicode Char
*
* <h2> Unicode C API </h2>
* The Unicode C API allows you to query the properties associated with individual
diff --git a/icu4c/source/common/unicode/ucnv.h b/icu4c/source/common/unicode/ucnv.h
index e1a3f38..1fe7106 100644
--- a/icu4c/source/common/unicode/ucnv.h
+++ b/icu4c/source/common/unicode/ucnv.h
@@ -18,7 +18,7 @@
/**
* \file
- * \brief Description of character conversion C API
+ * \brief C API: Character conversion
*
* <h2>Character Conversion C API </h2>
*
diff --git a/icu4c/source/common/unicode/udata.h b/icu4c/source/common/unicode/udata.h
index 92d0f4c..7959141 100644
--- a/icu4c/source/common/unicode/udata.h
+++ b/icu4c/source/common/unicode/udata.h
@@ -23,7 +23,7 @@
/**
* \file
- * \brief Descripton of data memory in C API
+ * \brief C API: Data memory
*
* <h2>Information about data memory. </h2>
* This structure may grow in the future, indicated by the
diff --git a/icu4c/source/common/unicode/uloc.h b/icu4c/source/common/unicode/uloc.h
index bf35381..c9f5442 100644
--- a/icu4c/source/common/unicode/uloc.h
+++ b/icu4c/source/common/unicode/uloc.h
@@ -25,7 +25,7 @@
/**
* \file
- * \brief Description of Locale C API
+ * \brief C API: Locale
*
* <h2> ULoc C API for Locale </h2>
* A <code>Locale</code> represents a specific geographical, political,
diff --git a/icu4c/source/common/unicode/umachine.h b/icu4c/source/common/unicode/umachine.h
index 40fec38a..6db5b1d 100644
--- a/icu4c/source/common/unicode/umachine.h
+++ b/icu4c/source/common/unicode/umachine.h
@@ -25,7 +25,7 @@
/**
* \file
- * \brief Description of basic types and constants for UTF C API
+ * \brief Basic types and constants for UTF
*
* <h2> Basic types and constants for UTF </h2>
* This file defines basic types and constants for utf.h to be
diff --git a/icu4c/source/common/unicode/umisc.h b/icu4c/source/common/unicode/umisc.h
index b44164b..536e30f 100644
--- a/icu4c/source/common/unicode/umisc.h
+++ b/icu4c/source/common/unicode/umisc.h
@@ -19,7 +19,7 @@
/**
* \file
- * \brief Description of misc definitions for C API
+ * \brief C API:misc definitions
*
* This file contains miscellaneous definitions for the C APIs.
*/
diff --git a/icu4c/source/common/unicode/unorm.h b/icu4c/source/common/unicode/unorm.h
index 3dc395b..439fba5 100644
--- a/icu4c/source/common/unicode/unorm.h
+++ b/icu4c/source/common/unicode/unorm.h
@@ -14,7 +14,7 @@
/**
* \file
- * \brief Description of Unicode Normalization C API
+ * \brief C API: Unicode Normalization
*
* <h2> Unicode normalization API </h2>
*
diff --git a/icu4c/source/common/unicode/ures.h b/icu4c/source/common/unicode/ures.h
index 971c1c5..8486ac3 100644
--- a/icu4c/source/common/unicode/ures.h
+++ b/icu4c/source/common/unicode/ures.h
@@ -27,9 +27,9 @@
/**
* \file
- * \brief Description of ResourceBundle C API
+ * \brief C API: Resource Bundle
*
- * <h2>ResourceBundle C API</h2>
+ * <h2>C API: Resource Bundle</h2>
*
* C API representing a collection of resource information pertaining to a given
* locale. A resource bundle provides a way of accessing locale- specific information in
diff --git a/icu4c/source/common/unicode/ushape.h b/icu4c/source/common/unicode/ushape.h
index d363e3d..4fd9ba8 100644
--- a/icu4c/source/common/unicode/ushape.h
+++ b/icu4c/source/common/unicode/ushape.h
@@ -23,7 +23,7 @@
/**
* \file
- * \brief Description of Arabic shaping C API
+ * \brief C API: Arabic shaping
*
*/
diff --git a/icu4c/source/common/unicode/ustring.h b/icu4c/source/common/unicode/ustring.h
index 366b975..1d16ad5 100644
--- a/icu4c/source/common/unicode/ustring.h
+++ b/icu4c/source/common/unicode/ustring.h
@@ -345,6 +345,7 @@
* which must not indicate a failure before the function call.
* @return The length of the result string. It may be greater than destCapacity. In that case,
* only some of the result was written to the destination buffer.
+ * @unimplemented
*/
U_CAPI int32_t U_EXPORT2
u_strToUpper(const UChar *src, int32_t srcLength,
@@ -369,6 +370,7 @@
* which must not indicate a failure before the function call.
* @return The length of the result string. It may be greater than destCapacity. In that case,
* only some of the result was written to the destination buffer.
+ * @unimplemented
*/
U_CAPI int32_t U_EXPORT2
u_strToLower(const UChar *src, int32_t srcLength,
