Fix 4.0 API Reference error 02/130302/2 submit/tizen/20170522.014426
authorHyunjee Kim <hj0426.kim@samsung.com>
Mon, 22 May 2017 01:21:42 +0000 (10:21 +0900)
committerMyoungJune Park <mj2004.park@samsung.com>
Mon, 22 May 2017 01:37:29 +0000 (10:37 +0900)
- file name error
- variables mismatch
- the location of define error
- adjust tab alignment

Change-Id: I6c3fc9739c1f1d3b66d7f0bbd615311569a3ee71
Signed-off-by: Hyunjee Kim <hj0426.kim@samsung.com>
Signed-off-by: MyoungJune Park <mj2004.park@samsung.com>
src/include/utils_i18n_types.h
src/include/utils_i18n_uchar_iter.h

index 325ff5b..5557c8c 100644 (file)
@@ -47,48 +47,56 @@ extern "C" {
  */
 typedef enum {
        I18N_ERROR_NONE                                                 = TIZEN_ERROR_NONE,                                       /**< No error, no warning */
-                                         I18N_ERROR_MISSING_RESOURCE                           = TIZEN_ERROR_UTILITY_ICU | 0x01,         /**< The requested resource cannot be found */
-                                                          I18N_ERROR_INVALID_FORMAT                            = TIZEN_ERROR_UTILITY_ICU | 0x02,         /**< Data format is not what is expected */
-                                                                                 I18N_ERROR_FILE_ACCESS                                        = TIZEN_ERROR_UTILITY_ICU | 0x03,         /**< The requested file cannot be found */
-                                                                                                          I18N_ERROR_INTERNAL_PROGRAM                          = TIZEN_ERROR_UTILITY_ICU | 0x04,         /**< Indicates a bug in the library code */
-                                                                                                                               I18N_ERROR_OUT_OF_MEMORY                                = TIZEN_ERROR_OUT_OF_MEMORY,              /**< Out of memory */
-                                                                                                                                                       I18N_ERROR_INDEX_OUTOFBOUNDS                    = TIZEN_ERROR_UTILITY_ICU | 0x05,         /**< Trying to access the index that is out of bounds */
-                                                                                                                                                                        I18N_ERROR_INVALID_CHAR_FOUND                  = TIZEN_ERROR_UTILITY_ICU | 0x06,         /**< Character conversion: Unmappable input sequence. In other APIs: Invalid character */
-                                                                                                                                                                                        I18N_ERROR_BUFFER_OVERFLOW                             = TIZEN_ERROR_UTILITY_ICU | 0x07,         /**< A result would not fit in the supplied buffer */
-                                                                                                                                                                                                          I18N_ERROR_NOT_SUPPORTED                             = TIZEN_ERROR_NOT_SUPPORTED,              /**< Requested operation is not supported in the current context */
-                                                                                                                                                                                                                                  I18N_ERROR_COLLATOR_VERSION_MISMATCH = TIZEN_ERROR_UTILITY_ICU | 0x08,         /**< Collator version is not compatible with the base version */
-                                                                                                                                                                                                                                         I18N_ERROR_USELESS_COLLATOR                           = TIZEN_ERROR_UTILITY_ICU | 0x09,         /**< Collator is options only and no base is specified */
-                                                                                                                                                                                                                                                          I18N_ERROR_NO_WRITE_PERMISSION                       = TIZEN_ERROR_UTILITY_ICU | 0x0A,         /**< Attempt to modify read-only or constant data */
-                                                                                                                                                                                                                                                                         I18N_ERROR_RESOURCE_TYPE_MISMATCH             = TIZEN_ERROR_UTILITY_ICU | 0x0B,         /**< An operation is requested over a resource that does not support it */
-                                                                                                                                                                                                                                                                                  I18N_ERROR_TOO_MANY_ALIASES                          = TIZEN_ERROR_UTILITY_ICU | 0x0C,         /**< Too many aliases in the path to the requested resource  */
-                                                                                                                                                                                                                                                                                                       I18N_ERROR_INVALID_PARAMETER                    = TIZEN_ERROR_INVALID_PARAMETER,          /**< Invalid function parameter */
-                                                                                                                                                                                                                                                                                                                        I18N_ERROR_PERMISSION_DENIED                   = TIZEN_ERROR_PERMISSION_DENIED,          /**< Permission denied */
-
-                                                                                                                                                                                                                                                                                                                                         I18N_ERROR_MESSAGE_PARSE                              = TIZEN_ERROR_UTILITY_ICU | 0x0D,         /**< Unable to parse a message (message format). @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                 I18N_ERROR_PARSE                                              = TIZEN_ERROR_UTILITY_ICU | 0x0E,         /**< Equivalent to Java ParseException. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                       I18N_ERROR_TRUNCATED_CHAR_FOUND                 = TIZEN_ERROR_UTILITY_ICU | 0x0F,         /**< Character conversion: Incomplete input sequence. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                 I18N_ERROR_ILLEGAL_CHAR_FOUND                 = TIZEN_ERROR_UTILITY_ICU | 0x10,         /**< Character conversion: Illegal input sequence/combination of input units. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                 I18N_ERROR_INVALID_TABLE_FORMAT                       = TIZEN_ERROR_UTILITY_ICU | 0x11,         /**< Conversion table file found, but corrupted. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                               I18N_ERROR_INVALID_TABLE_FILE                   = TIZEN_ERROR_UTILITY_ICU | 0x12,         /**< Conversion table file not found. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                               I18N_ERROR_ILLECAL_ESCAPE_SEQUENCE              = TIZEN_ERROR_UTILITY_ICU | 0x13,         /**< ISO-2022 illegal escape sequence. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                       I18N_ERROR_UNSUPPORTED_ESCAPE_SEQUENCE  = TIZEN_ERROR_UTILITY_ICU | 0x14,         /**< ISO-2022 unsupported escape sequence. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                        I18N_ERROR_NO_SPACE_AVAILABLE                  = TIZEN_ERROR_UTILITY_ICU | 0x15,         /**< No space available for in-buffer expansion for Arabic shaping. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        I18N_ERROR_CE_NOT_FOUND                                        = TIZEN_ERROR_UTILITY_ICU | 0x16,         /**< Currently used only while setting variable top, but can be used generally. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                I18N_ERROR_PRIMARY_TOO_LONG                            = TIZEN_ERROR_UTILITY_ICU | 0x17,         /**< User tried to set variable top to a primary that is longer than two bytes. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 I18N_ERROR_STATE_TOO_OLD                              = TIZEN_ERROR_UTILITY_ICU | 0x18,         /**< ICU cannot construct a service from this state, as it is no longer supported. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         I18N_ERROR_ENUM_OUT_OF_SYNC                           = TIZEN_ERROR_UTILITY_ICU | 0x19,         /**< UEnumeration out of sync with underlying collection. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          I18N_ERROR_INVARIANT_CONVERSION                      = TIZEN_ERROR_UTILITY_ICU | 0x1A,         /**< Unable to convert a UChar* string to char* with the invariant converter. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        I18N_ERROR_INVALID_STATE                               = TIZEN_ERROR_UTILITY_ICU | 0x1B,         /**< Requested operation can not be completed with ICU in its current state. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                I18N_ERROR_MALFORMED_SET                               = TIZEN_ERROR_UTILITY_ICU | 0x1C,         /**< A UnicodeSet pattern is invalid. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        I18N_WARNING_STRING_NOT_TERMINATED             = TIZEN_ERROR_UTILITY_ICU | 0x1D,         /**< String not terminated with NULL. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                I18N_ERROR_STD3_ASCII_RULES                            = TIZEN_ERROR_UTILITY_ICU | 0x1E,         /**< Argument does not satisfy STD3 rules. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 I18N_ERROR_UNASSIGNED                                 = TIZEN_ERROR_UTILITY_ICU | 0x1F,         /**< Unassigned code points are found. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               I18N_WARNING_SORT_KEY_TOO_SHORT                 = TIZEN_ERROR_UTILITY_ICU | 0x20,         /**< Number of levels requested in getBound is higher than the number of levels in the sort key. @if MOBILE (Since 2.3.1) @endif*/
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         I18N_ERROR_UNKNOWN                                            = TIZEN_ERROR_UNKNOWN,                            /**< Unknown error. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_MISSING_RESOURCE                             = TIZEN_ERROR_UTILITY_ICU | 0x01,         /**< The requested resource cannot be found */
+       I18N_ERROR_INVALID_FORMAT                               = TIZEN_ERROR_UTILITY_ICU | 0x02,         /**< Data format is not what is expected */
+       I18N_ERROR_FILE_ACCESS                                  = TIZEN_ERROR_UTILITY_ICU | 0x03,         /**< The requested file cannot be found */
+       I18N_ERROR_INTERNAL_PROGRAM                             = TIZEN_ERROR_UTILITY_ICU | 0x04,         /**< Indicates a bug in the library code */
+       I18N_ERROR_OUT_OF_MEMORY                                = TIZEN_ERROR_OUT_OF_MEMORY,              /**< Out of memory */
+       I18N_ERROR_INDEX_OUTOFBOUNDS                    = TIZEN_ERROR_UTILITY_ICU | 0x05,         /**< Trying to access the index that is out of bounds */
+       I18N_ERROR_INVALID_CHAR_FOUND                   = TIZEN_ERROR_UTILITY_ICU | 0x06,         /**< Character conversion: Unmappable input sequence. In other APIs: Invalid character */
+       I18N_ERROR_BUFFER_OVERFLOW                              = TIZEN_ERROR_UTILITY_ICU | 0x07,         /**< A result would not fit in the supplied buffer */
+       I18N_ERROR_NOT_SUPPORTED                                = TIZEN_ERROR_NOT_SUPPORTED,              /**< Requested operation is not supported in the current context */
+       I18N_ERROR_COLLATOR_VERSION_MISMATCH    = TIZEN_ERROR_UTILITY_ICU | 0x08,         /**< Collator version is not compatible with the base version */
+       I18N_ERROR_USELESS_COLLATOR                             = TIZEN_ERROR_UTILITY_ICU | 0x09,         /**< Collator is options only and no base is specified */
+       I18N_ERROR_NO_WRITE_PERMISSION                  = TIZEN_ERROR_UTILITY_ICU | 0x0A,         /**< Attempt to modify read-only or constant data */
+       I18N_ERROR_RESOURCE_TYPE_MISMATCH               = TIZEN_ERROR_UTILITY_ICU | 0x0B,         /**< An operation is requested over a resource that does not support it */
+       I18N_ERROR_TOO_MANY_ALIASES                             = TIZEN_ERROR_UTILITY_ICU | 0x0C,         /**< Too many aliases in the path to the requested resource  */
+       I18N_ERROR_INVALID_PARAMETER                    = TIZEN_ERROR_INVALID_PARAMETER,          /**< Invalid function parameter */
+       I18N_ERROR_PERMISSION_DENIED                    = TIZEN_ERROR_PERMISSION_DENIED,          /**< Permission denied */
+
+       I18N_ERROR_MESSAGE_PARSE                                = TIZEN_ERROR_UTILITY_ICU | 0x0D,         /**< Unable to parse a message (message format). @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_PARSE                                                = TIZEN_ERROR_UTILITY_ICU | 0x0E,         /**< Equivalent to Java ParseException. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_TRUNCATED_CHAR_FOUND                 = TIZEN_ERROR_UTILITY_ICU | 0x0F,         /**< Character conversion: Incomplete input sequence. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_ILLEGAL_CHAR_FOUND                   = TIZEN_ERROR_UTILITY_ICU | 0x10,         /**< Character conversion: Illegal input sequence/combination of input units. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_INVALID_TABLE_FORMAT                 = TIZEN_ERROR_UTILITY_ICU | 0x11,         /**< Conversion table file found, but corrupted. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_INVALID_TABLE_FILE                   = TIZEN_ERROR_UTILITY_ICU | 0x12,         /**< Conversion table file not found. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_ILLECAL_ESCAPE_SEQUENCE              = TIZEN_ERROR_UTILITY_ICU | 0x13,         /**< ISO-2022 illegal escape sequence. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_UNSUPPORTED_ESCAPE_SEQUENCE  = TIZEN_ERROR_UTILITY_ICU | 0x14,         /**< ISO-2022 unsupported escape sequence. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_NO_SPACE_AVAILABLE                   = TIZEN_ERROR_UTILITY_ICU | 0x15,         /**< No space available for in-buffer expansion for Arabic shaping. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_CE_NOT_FOUND                                 = TIZEN_ERROR_UTILITY_ICU | 0x16,         /**< Currently used only while setting variable top, but can be used generally. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_PRIMARY_TOO_LONG                             = TIZEN_ERROR_UTILITY_ICU | 0x17,         /**< User tried to set variable top to a primary that is longer than two bytes. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_STATE_TOO_OLD                                = TIZEN_ERROR_UTILITY_ICU | 0x18,         /**< ICU cannot construct a service from this state, as it is no longer supported. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_ENUM_OUT_OF_SYNC                             = TIZEN_ERROR_UTILITY_ICU | 0x19,         /**< UEnumeration out of sync with underlying collection. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_INVARIANT_CONVERSION                 = TIZEN_ERROR_UTILITY_ICU | 0x1A,         /**< Unable to convert a UChar* string to char* with the invariant converter. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_INVALID_STATE                                = TIZEN_ERROR_UTILITY_ICU | 0x1B,         /**< Requested operation can not be completed with ICU in its current state. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_MALFORMED_SET                                = TIZEN_ERROR_UTILITY_ICU | 0x1C,         /**< A UnicodeSet pattern is invalid. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_WARNING_STRING_NOT_TERMINATED              = TIZEN_ERROR_UTILITY_ICU | 0x1D,         /**< String not terminated with NULL. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_STD3_ASCII_RULES                             = TIZEN_ERROR_UTILITY_ICU | 0x1E,         /**< Argument does not satisfy STD3 rules. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_UNASSIGNED                                   = TIZEN_ERROR_UTILITY_ICU | 0x1F,         /**< Unassigned code points are found. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_WARNING_SORT_KEY_TOO_SHORT                 = TIZEN_ERROR_UTILITY_ICU | 0x20,         /**< Number of levels requested in getBound is higher than the number of levels in the sort key. @if MOBILE (Since 2.3.1) @endif*/
+       I18N_ERROR_UNKNOWN                                              = TIZEN_ERROR_UNKNOWN,                            /**< Unknown error. @if MOBILE (Since 2.3.1) @endif*/
 }
 i18n_error_code_e;
 
 /**
+ * @brief This value is intended for sentinel values for APIs that take or return single code points (#i18n_uchar32).
+ * @details It is outside of the Unicode code point range 0..0x10ffff. For example, a "done" or "error" value in a new
+ *                     API could be indicated with #I18N_SENTINEL.
+ * @since_tizen 4.0
+ */
+#define I18N_SENTINEL (-1)
+
+/**
  * @}
  */
 
@@ -4009,14 +4017,6 @@ typedef void *i18n_uchar_iter_h;
  * @}
  */
 
-/**
- * @brief This value is intended for sentinel values for APIs that take or return single code points (#i18n_uchar32).
- * @details It is outside of the Unicode code point range 0..0x10ffff. For example, a "done" or "error" value in a new
- *                     API could be indicated with #I18N_SENTINEL.
- * @since_tizen 4.0
- */
-#define I18N_SENTINEL (-1)
-
 #ifdef __cplusplus
 }
 #endif
index bec429b..93438cc 100644 (file)
@@ -20,7 +20,7 @@
 #include <utils_i18n_types.h>
 
 /**
- * @file utils_i18n_uchar_iterator.h
+ * @file utils_i18n_uchar_iter.h
  * @version 0.1
  * @brief utils_i18n_uchar_iterator
  */
@@ -251,7 +251,7 @@ int i18n_uchar_iter_next(i18n_uchar_iter_h iter, i18n_uchar32 *current);
  * @since_tizen 4.0
  *
  * @param[in]  iter                    The #i18n_uchar_iter_h object
- * @param[out] current                 The current code unit
+ * @param[out] previous                The previous code unit
  *
  * @return @c 0 on success, otherwise a negative error value
  * @retval #I18N_ERROR_NONE                            Successful