[Base-utils][Format] Consistency between 2.3.2 and 3.0 fixed 17/81617/12
authorRafal Szczekutek <r.szczekutek@samsung.com>
Fri, 12 Aug 2016 15:35:36 +0000 (17:35 +0200)
committerRafal Szczekutek <r.szczekutek@samsung.com>
Fri, 12 Aug 2016 15:35:36 +0000 (17:35 +0200)
Paramater name fixes
i18n_formattable_equal() and i18n_formattable_not_equal() functions fixes
1i8n_formattable_element_at() function fixes

Change-Id: Ia0f2711b7e0bd08b653528825586df64cb14f007
Signed-off-by: Rafal Szczekutek <r.szczekutek@samsung.com>
13 files changed:
src/include/mobile/utils_i18n_alpha_idx.h
src/include/mobile/utils_i18n_field_position.h
src/include/mobile/utils_i18n_format.h
src/include/mobile/utils_i18n_formattable.h
src/include/mobile/utils_i18n_types.h
src/include/wearable/utils_i18n_alpha_idx.h
src/include/wearable/utils_i18n_field_position.h
src/include/wearable/utils_i18n_format.h
src/include/wearable/utils_i18n_formattable.h
src/include/wearable/utils_i18n_measure_unit.h
src/include/wearable/utils_i18n_types.h
src/utils_i18n_format.cpp
src/utils_i18n_formattable.cpp

index 2b9bd5c23054f399b19cfaaf03c53f324054f2fc..dffeaf5f29265ca0573c290cd679e45037b047a6 100644 (file)
@@ -62,9 +62,9 @@ extern "C" {
  *          exemplar characters. The locale determines the sorting order
  *          for both the index characters and the user item names appearing
  *          under each Index character.
+ * @since_tizen 3.0
  * @remarks The created object should be released by the caller with the
  *          #i18n_alpha_idx_destroy() function.
- * @since_tizen 3.0
  *
  * @param[in] language  The language of the locale
  * @param[in] country   The country of the locale
@@ -185,8 +185,8 @@ int i18n_alpha_idx_get_bucket_record_count(i18n_alpha_idx_h index, int32_t *reco
  * @details If the iteration is before the first Bucket
  *          (i18n_alpha_idx_get_next_bucket() has not been called),
  *          or after the last, return an empty string.
- * @remarks The obtained @a label should be released by the caller with the free() function.
  * @since_tizen 3.0
+ * @remarks The obtained @a label should be released by the caller with the free() function.
  *
  * @param[in] index   The alphabetic index, which contains buckets
  * @param[out] label  The name of the label of the current bucket
@@ -203,10 +203,10 @@ int i18n_alpha_idx_get_bucket_label(i18n_alpha_idx_h index, char **label);
  * @details Returns NULL if:
  *          - the current iteration position is before the first item in this Bucket,
  *            or after the last,
-*           - the given @a index parameter is invalid.
+ *          - the given @a index parameter is invalid.
+ * @since_tizen 3.0
  * @remarks The specific error code can be obtained using the get_last_result() method.
  *          Error codes are described in Exceptions section.
- * @since_tizen 3.0
  *
  * @param[in] index  The alphabetic index, which contains buckets with records
  *
@@ -220,8 +220,8 @@ const void *i18n_alpha_idx_get_record_data(i18n_alpha_idx_h index);
  * @brief Gets the default label used for abbreviated buckets between other index characters.
  * @details For example, consider the labels when Latin and Greek are used:
  *          X Y Z ... &#x0391; &#x0392; &#x0393;
- * @remarks The obtained @a label should be released by the caller with the free() function.
  * @since_tizen 3.0
+ * @remarks The obtained @a label should be released by the caller with the free() function.
  *
  * @param[in] index  The alphabetic index, which contains buckets with records
  * @param[out] label The default label used for abbreviated bucket between other index characters
@@ -252,8 +252,8 @@ int i18n_alpha_idx_set_inflow_label(i18n_alpha_idx_h index, const char *label);
 /**
  * @brief Gets the special label used for items that sort after the last normal label,
  *        and that would not otherwise have an appropriate label.
- * @remarks The obtained @a label should be released by the caller with the free() function.
  * @since_tizen 3.0
+ * @remarks The obtained @a label should be released by the caller with the free() function.
  *
  * @param[in] index   The alphabetic index, which contains buckets with records
  * @param[out] label  The overflow label
@@ -282,8 +282,8 @@ int i18n_alpha_idx_set_overflow_label(i18n_alpha_idx_h index, const char *label)
 /**
  * @brief Gets the special label used for items that sort before the first normal label,
  *        and that would not otherwise have an appropriate label.
- * @remarks The obtained @a label should be released by the caller with the free() function.
  * @since_tizen 3.0
+ * @remarks The obtained @a label should be released by the caller with the free() function.
  *
  * @param[in] index   The alphabetic index, which contains buckets with records
  * @param[out] label  The underflow label
@@ -356,8 +356,8 @@ int i18n_alpha_idx_clear_records(i18n_alpha_idx_h index);
 
 /**
  * @brief Gets the number of labels in this index.
- * @remarks Note: may trigger lazy index construction.
  * @since_tizen 3.0
+ * @remarks Note: may trigger lazy index construction.
  *
  * @param[in] index          The alphabetic index, which contains buckets with records
  * @param[out] bucket_count  The number of labels in this index, including any under,
@@ -438,8 +438,8 @@ int i18n_alpha_idx_get_bucket_label_type(i18n_alpha_idx_h index,
  * @details If the Record iteration position is before the first or after the last record,
  *          sets the string pointed by the @a record_name parameter to NULL and returns
  *          the #I18N_ERROR_INDEX_OUTOFBOUNDS error code.
- * @remarks The obtained @a record_name should be released by the caller with the free() function.
  * @since_tizen 3.0
+ * @remarks The obtained @a record_name should be released by the caller with the free() function.
  *
  * @param[in] index        The alphabetic index, which contains buckets with records
  * @param[out] record_name The name of the current index item
index 9ea3878fa5c8488db6be5125612de185fcb71aa7..62c639f19fe269dc3297e866e7fd55a47c3f867a 100644 (file)
@@ -71,7 +71,7 @@ int i18n_field_position_create(i18n_field_position_h *field_position);
 /**
  * @brief Creates a field position object for the given field.
  * @details The only fields currently supported are the fields accepted by the date formatter,
- *                     see #i18n_udate_format_field_e.
+ *             see #i18n_udate_format_field_e.
  * @since_tizen 3.0
  * @remarks The created object should be released by the caller with the
  *          i18n_field_position_destroy() function.
index 87c3da0f3dec8e4ab2a3144832fe1bdf72e45f93..202eb989a32da957c571c7178d8215438050d874 100644 (file)
@@ -174,7 +174,7 @@ int i18n_format_parse_object_with_parse_position(i18n_format_h format, const cha
  * @retval #I18N_ERROR_OUT_OF_MEMORY Out of memory
  */
 int i18n_format_get_locale(i18n_format_h format,
-        i18n_uloc_data_locale_type_e type, char **language, char **country);
+        i18n_ulocale_data_locale_type_e type, char **language, char **country);
 
 /**
  * @}
index 4c76c90fccce3b0c3830d63796837710dc4b911f..7ad3aa9efa387781981cc096721f669e889aba0a 100644 (file)
@@ -207,9 +207,10 @@ int i18n_formattable_clone(i18n_formattable_h formattable, i18n_formattable_h *c
  * @brief Gets the array value and count of the given formattable object.
  * @since_tizen 3.0
  * @remarks If this object is not of type #I18N_FORMATTABLE_TYPE_ARRAY then the
- *          result is undefined.
+ *          result is undefined. The obtained array should be released by the
+ *          caller with the free() function.
  *
- * @param[in] formattable  A handle to the formattable object
+ * @param[in] formattable   A handle to the formattable object
  * @param[out] array        A pointer to an array of #i18n_formattable_h handles
  * @param[out] count        A pointer to an int32_t variable which will be filled
  *                          with the number of array's elements
index f20c2671b43a005cd07995eebded9548893c16b0..e9bbd1f9e77fd8053546b4900a024501ea325ec6 100644 (file)
@@ -88,7 +88,6 @@ typedef enum {
 } i18n_error_code_e;
 
 /**
- * @}
  * @}
  */
 
@@ -1212,7 +1211,6 @@ typedef enum {
 } i18n_uchar_u_grapheme_cluster_break_e;
 
 /**
- * @}
  * @}
  */
 
@@ -1295,7 +1293,6 @@ typedef enum {
 } i18n_ucollator_result_e;
 
 /**
- * @}
  * @}
  */
 
@@ -1345,7 +1342,6 @@ typedef enum {
 } i18n_unormalization_check_result_e;
 
 /**
- * @}
  * @}
  */
 
@@ -1361,7 +1357,6 @@ typedef enum {
 typedef void *i18n_usearch_h;
 
 /**
- * @}
  * @}
  */
 
@@ -1552,7 +1547,6 @@ typedef enum {
 } i18n_utimezone_transition_type_e;
 
 /**
- * @}
  * @}
  */
 
@@ -1988,7 +1982,6 @@ typedef enum {
 #define I18N_UDATE_MINUTE_SECOND                         "ms"
 
 /**
- * @}
  * @}
  */
 
@@ -2052,7 +2045,6 @@ typedef enum {
 } i18n_udatepg_date_time_pattern_conflict_e;
 
 /**
- * @}
  * @}
  */
 
@@ -2213,7 +2205,6 @@ typedef enum {
 } i18n_unumber_format_text_attribute_e;
 
 /**
- * @}
  * @}
  */
 
@@ -2374,7 +2365,6 @@ typedef enum {
 } i18n_ulocale_layout_type_e;
 
 /**
- * @}
  * @}
  */
 
@@ -2420,7 +2410,6 @@ typedef i18n_uchar(*i18n_ustring_unescape_char_at_cb)(int32_t offset, void *cont
 #define I18N_USTRING_U_FOLD_CASE_EXCLUDE_SPECIAL_I 1
 
 /**
- * @}
  * @}
  */
 
@@ -2465,7 +2454,6 @@ typedef enum {
 } i18n_timezone_display_type_e;
 
 /**
- * @}
  * @}
  */
 
@@ -2512,7 +2500,6 @@ typedef enum {
 } i18n_ubreak_iterator_type_e;
 
 /**
- * @}
  * @}
  */
 
@@ -2624,7 +2611,6 @@ enum {
 };
 
 /**
- * @}
  * @}
  */
 
@@ -2641,7 +2627,6 @@ enum {
 typedef void *i18n_uenumeration_h;
 
 /**
- * @}
  * @}
  */
 
@@ -2822,12 +2807,30 @@ typedef enum {
        I18N_USCRIPT_CODE_LIMIT                                    = 159 /**< Count of i18n_uscript_code_e enumerators*/
 } i18n_uscript_code_e;
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_FORMAT_MODULE
+ * @{
+ */
+
 /**
  * @brief Handle to the object of base class for all formats.
  * @since_tizen 3.0
  */
 typedef void *i18n_format_h;
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_MEASURE_FORMAT_MODULE
+ * @{
+ */
+
 /**
  * @brief Handle to the object that represents a formatter for measure objects.
  * @since_tizen 3.0
@@ -2847,6 +2850,15 @@ typedef enum {
     I18N_UMEASFMT_WIDTH_COUNT = 4,    /**< Count of values in this enumeration */
 } i18n_umeasure_format_width_e;
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_FORMATTABLE_MODULE
+ * @{
+ */
+
 /**
  * @brief Handle to the object of class used for formatting #i18n_format_h and its subclasses.
  * @since_tizen 3.0
@@ -2861,7 +2873,7 @@ typedef enum {
     I18N_FORMATTABLE_TYPE_DATE = 0,    /**< Selector indicating an #i18n_udate value */
     I18N_FORMATTABLE_TYPE_DOUBLE = 1,  /**< Selector indicating a double value */
     I18N_FORMATTABLE_TYPE_LONG = 2,    /**< Selector indicating a 32-bit integer value */
-    I18N_FORMATTABLE_TYPE_STRING = 3,  /**< Selector indicating a string */
+    I18N_FORMATTABLE_TYPE_STRING = 3,  /**< Selector indicating a string value */
     I18N_FORMATTABLE_TYPE_ARRAY = 4,   /**< Selector indicating an array of #i18n_formattable_h */
     I18N_FORMATTABLE_TYPE_INT64 = 5,   /**< Selector indicating a 64-bit integer value */
     I18N_FORMATTABLE_TYPE_OBJECT = 6,  /**< Selector indicating a generic object value.
@@ -2870,6 +2882,14 @@ typedef enum {
                                             was added for completeness and possible future extensions. */
 } i18n_formattable_type_e;
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_MEASURE_MODULE
+ * @{
+ */
 
 /**
  * @brief Handle to the object that represents an amount of a specified unit.
@@ -2877,6 +2897,15 @@ typedef enum {
  */
 typedef void *i18n_measure_h;
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_MEASURE_UNIT_MODULE
+ * @{
+ */
+
 /**
  * @brief Handle to the object that represents a unit such as length, mass, volume, currency, etc.
  * @since_tizen 3.0
@@ -2897,14 +2926,13 @@ typedef void *i18n_measure_unit_h;
 typedef bool (*i18n_measure_unit_types_cb)(const char *type_id, void *user_data);
 
 /**
- * @brief Enumeration for the flavor of data type contained within an #i18n_formattable_h object.
- * @since_tizen 3.0
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_ALPHABETIC_INDEX_MODULE
+ * @{
  */
-typedef enum {
-    I18N_ULOC_ACTUAL_LOCALE = 0,    /**< This is locale the data actually comes from */
-    I18N_ULOC_VALID_LOCALE = 1,     /**< This is the most specific locale supported by the ICU */
-    I18N_ULOC_REQUESTED_LOCALE = 2, /**< This is the requested locale (deprecated) */
-} i18n_uloc_data_locale_type_e;
 
 /*
  * @brief The Alphabetic index handle.
@@ -2952,7 +2980,16 @@ typedef enum {
 } i18n_alpha_idx_label_type_e;
 
 /**
- * @brief A simple type used by Format module and its submodules to identify fields in formatted output.
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_FIELD_POSITION_MODULE
+ * @{
+ */
+
+/**
+ * @brief Handle to the object of class used by the #i18n_format_h and its subclasses to identify fields in a formatted output.
  * @since_tizen 3.0
  */
 typedef void *i18n_field_position_h;
@@ -2966,11 +3003,24 @@ typedef enum {
 } i18n_field_position_dont_care_e;
 
 /**
- * @brief A simple type used by Format module and its submodules to identify fields in formatted output.
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_FIELD_POSITION_MODULE
+ * @{
+ */
+
+/**
+ * @brief Handle to the object used by the Format and its subtypes to keep track of the current position during parsing.
  * @since_tizen 3.0
  */
 typedef void *i18n_parse_position_h;
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif
index 4cb36cef88b377041a2eaa1e957912e89d7ecf52..1955f79dc10b58a8d5a044788d3b554c49bffbbe 100644 (file)
@@ -62,9 +62,9 @@ extern "C" {
  *          exemplar characters. The locale determines the sorting order
  *          for both the index characters and the user item names appearing
  *          under each Index character.
+ * @since_tizen 2.3.2
  * @remarks The created object should be released by the caller with the
  *          #i18n_alpha_idx_destroy() function.
- * @since_tizen 2.3.2
  *
  * @param[in] language  The language of the locale
  * @param[in] country   The country of the locale
@@ -185,8 +185,8 @@ int i18n_alpha_idx_get_bucket_record_count(i18n_alpha_idx_h index, int32_t *reco
  * @details If the iteration is before the first Bucket
  *          (i18n_alpha_idx_get_next_bucket() has not been called),
  *          or after the last, return an empty string.
- * @remarks The obtained @a label should be released by the caller with the free() function.
  * @since_tizen 2.3.2
+ * @remarks The obtained @a label should be released by the caller with the free() function.
  *
  * @param[in] index   The alphabetic index, which contains buckets
  * @param[out] label  The name of the label of the current bucket
@@ -203,10 +203,10 @@ int i18n_alpha_idx_get_bucket_label(i18n_alpha_idx_h index, char **label);
  * @details Returns NULL if:
  *          - the current iteration position is before the first item in this Bucket,
  *            or after the last,
-*           - the given @a index parameter is invalid.
+ *          - the given @a index parameter is invalid.
+ * @since_tizen 2.3.2
  * @remarks The specific error code can be obtained using the get_last_result() method.
  *          Error codes are described in Exceptions section.
- * @since_tizen 2.3.2
  *
  * @param[in] index  The alphabetic index, which contains buckets with records
  *
@@ -220,8 +220,8 @@ const void *i18n_alpha_idx_get_record_data(i18n_alpha_idx_h index);
  * @brief Gets the default label used for abbreviated buckets between other index characters.
  * @details For example, consider the labels when Latin and Greek are used:
  *          X Y Z ... &#x0391; &#x0392; &#x0393;
- * @remarks The obtained @a label should be released by the caller with the free() function.
  * @since_tizen 2.3.2
+ * @remarks The obtained @a label should be released by the caller with the free() function.
  *
  * @param[in] index  The alphabetic index, which contains buckets with records
  * @param[out] label The default label used for abbreviated bucket between other index characters
@@ -282,8 +282,8 @@ int i18n_alpha_idx_set_overflow_label(i18n_alpha_idx_h index, const char *label)
 /**
  * @brief Gets the special label used for items that sort before the first normal label,
  *        and that would not otherwise have an appropriate label.
- * @remarks The obtained @a label should be released by the caller with the free() function.
  * @since_tizen 2.3.2
+ * @remarks The obtained @a label should be released by the caller with the free() function.
  *
  * @param[in] index   The alphabetic index, which contains buckets with records
  * @param[out] label  The underflow label
@@ -356,8 +356,8 @@ int i18n_alpha_idx_clear_records(i18n_alpha_idx_h index);
 
 /**
  * @brief Gets the number of labels in this index.
- * @remarks Note: may trigger lazy index construction.
  * @since_tizen 2.3.2
+ * @remarks Note: may trigger lazy index construction.
  *
  * @param[in] index          The alphabetic index, which contains buckets with records
  * @param[out] bucket_count  The number of labels in this index, including any under,
@@ -438,8 +438,8 @@ int i18n_alpha_idx_get_bucket_label_type(i18n_alpha_idx_h index,
  * @details If the Record iteration position is before the first or after the last record,
  *          sets the string pointed by the @a record_name parameter to NULL and returns
  *          the #I18N_ERROR_INDEX_OUTOFBOUNDS error code.
- * @remarks The obtained @a record_name should be released by the caller with the free() function.
  * @since_tizen 2.3.2
+ * @remarks The obtained @a record_name should be released by the caller with the free() function.
  *
  * @param[in] index        The alphabetic index, which contains buckets with records
  * @param[out] record_name The name of the current index item
index 04b8b4293232c9f483751325bfa3029b860a0467..85a37f1cec1cc75cab5ff9f5e59e66a96f302fc6 100644 (file)
@@ -71,7 +71,7 @@ int i18n_field_position_create(i18n_field_position_h *field_position);
 /**
  * @brief Creates a field position object for the given field.
  * @details The only fields currently supported are the fields accepted by the date formatter,
- *                     see #i18n_udate_format_field_e.
+ *             see #i18n_udate_format_field_e.
  * @since_tizen 2.3.2
  * @remarks The created object should be released by the caller with the
  *          i18n_field_position_destroy() function.
index 1422f4e2ed5b1de53a4aa002c71040e4c9ae731f..335be03f942ffadfff6b7ea619adca822e73aecf 100644 (file)
@@ -174,7 +174,7 @@ int i18n_format_parse_object_with_parse_position(i18n_format_h format, const cha
  * @retval #I18N_ERROR_OUT_OF_MEMORY Out of memory
  */
 int i18n_format_get_locale(i18n_format_h format,
-        i18n_uloc_data_locale_type_e type, char **language, char **country);
+        i18n_ulocale_data_locale_type_e type, char **language, char **country);
 
 /**
  * @}
index 4f228d5805c89fff3f5339fca367aebde184b903..f091bcbe4e22d67a4fe14c6c2a130bc006e3acb8 100644 (file)
@@ -207,9 +207,10 @@ int i18n_formattable_clone(i18n_formattable_h formattable, i18n_formattable_h *c
  * @brief Gets the array value and count of the given formattable object.
  * @since_tizen 2.3.2
  * @remarks If this object is not of type #I18N_FORMATTABLE_TYPE_ARRAY then the
- *          result is undefined.
+ *          result is undefined. The obtained array should be released by the
+ *          caller with the free() function.
  *
- * @param[in] formattable  A handle to the formattable object
+ * @param[in] formattable   A handle to the formattable object
  * @param[out] array        A pointer to an array of #i18n_formattable_h handles
  * @param[out] count        A pointer to an int32_t variable which will be filled
  *                          with the number of array's elements
index 011531556d42323aaa92aba0c7e8a2e72ee4a0d2..301c28d2181147ac2d96857d2dc3e8ce7b4efc17 100644 (file)
@@ -129,13 +129,13 @@ int i18n_measure_unit_get_type(i18n_measure_unit_h measure_unit, char **type);
  * @retval #I18N_ERROR_INVALID_PARAMETER Invalid function parameter
  * @retval #I18N_ERROR_OUT_OF_MEMORY Out of memory
  */
-int i18n_measure_unit_get_subtype(i18n_measur_unit_h measure_unit, char **subtype);
+int i18n_measure_unit_get_subtype(i18n_measure_unit_h measure_unit, char **subtype);
 
 /**
  * @brief Gets the available units.
  * @details The function creates the array with the results.
  *          If there are more units available than the given @a max_count
- *          then the returned list is truncated to the first @a max_count units
+ *          then the returned array is truncated to the first @a max_count units
  *          and the returned error code is #I18N_ERROR_BUFFER_OVERFLOW.
  *
  * @since_tizen 2.3.2
@@ -158,7 +158,7 @@ int i18n_measure_unit_get_available(int32_t max_count, i18n_measure_unit_h **out
  * @brief Gets the available units for a specific type.
  * @details The function creates the array with the results.
  *          If there are more units available than the given @a max_count
- *          then the returned list is truncated to the first @a max_count units
+ *          then the returned array is truncated to the first @a max_count units
  *          and the returned error code is #I18N_ERROR_BUFFER_OVERFLOW.
  *
  * @since_tizen 2.3.2
index d715d11b6327941ffd3895b7d7159642c946c749..2a217bde723e7292d9a91e6311cd1ce2bcc44f1b 100644 (file)
@@ -70,7 +70,7 @@ typedef enum {
        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 illlegal escape sequence. @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*/
@@ -88,7 +88,6 @@ typedef enum {
 } i18n_error_code_e;
 
 /**
- * @}
  * @}
  */
 
@@ -1212,7 +1211,6 @@ typedef enum {
 } i18n_uchar_u_grapheme_cluster_break_e;
 
 /**
- * @}
  * @}
  */
 
@@ -1295,7 +1293,6 @@ typedef enum {
 } i18n_ucollator_result_e;
 
 /**
- * @}
  * @}
  */
 
@@ -1345,7 +1342,6 @@ typedef enum {
 } i18n_unormalization_check_result_e;
 
 /**
- * @}
  * @}
  */
 
@@ -1361,7 +1357,6 @@ typedef enum {
 typedef void *i18n_usearch_h;
 
 /**
- * @}
  * @}
  */
 
@@ -1552,7 +1547,6 @@ typedef enum {
 } i18n_utimezone_transition_type_e;
 
 /**
- * @}
  * @}
  */
 
@@ -1988,7 +1982,6 @@ typedef enum {
 #define I18N_UDATE_MINUTE_SECOND                         "ms"
 
 /**
- * @}
  * @}
  */
 
@@ -2052,7 +2045,6 @@ typedef enum {
 } i18n_udatepg_date_time_pattern_conflict_e;
 
 /**
- * @}
  * @}
  */
 
@@ -2213,7 +2205,6 @@ typedef enum {
 } i18n_unumber_format_text_attribute_e;
 
 /**
- * @}
  * @}
  */
 
@@ -2374,7 +2365,6 @@ typedef enum {
 } i18n_ulocale_layout_type_e;
 
 /**
- * @}
  * @}
  */
 
@@ -2420,7 +2410,6 @@ typedef i18n_uchar(*i18n_ustring_unescape_char_at_cb)(int32_t offset, void *cont
 #define I18N_USTRING_U_FOLD_CASE_EXCLUDE_SPECIAL_I 1
 
 /**
- * @}
  * @}
  */
 
@@ -2465,7 +2454,6 @@ typedef enum {
 } i18n_timezone_display_type_e;
 
 /**
- * @}
  * @}
  */
 
@@ -2512,7 +2500,6 @@ typedef enum {
 } i18n_ubreak_iterator_type_e;
 
 /**
- * @}
  * @}
  */
 
@@ -2624,7 +2611,6 @@ enum {
 };
 
 /**
- * @}
  * @}
  */
 
@@ -2641,7 +2627,6 @@ enum {
 typedef void *i18n_uenumeration_h;
 
 /**
- * @}
  * @}
  */
 
@@ -2822,12 +2807,30 @@ typedef enum {
        I18N_USCRIPT_CODE_LIMIT                                    = 159 /**< Count of i18n_uscript_code_e enumerators*/
 } i18n_uscript_code_e;
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_FORMAT_MODULE
+ * @{
+ */
+
 /**
  * @brief Handle to the object of base class for all formats.
  * @since_tizen 2.3.2
  */
 typedef void *i18n_format_h;
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_MEASURE_FORMAT_MODULE
+ * @{
+ */
+
 /**
  * @brief Handle to the object that represents a formatter for measure objects.
  * @since_tizen 2.3.2
@@ -2847,6 +2850,15 @@ typedef enum {
     I18N_UMEASFMT_WIDTH_COUNT = 4,    /**< Count of values in this enumeration */
 } i18n_umeasure_format_width_e;
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_FORMATTABLE_MODULE
+ * @{
+ */
+
 /**
  * @brief Handle to the object of class used for formatting #i18n_format_h and its subclasses.
  * @since_tizen 2.3.2
@@ -2870,12 +2882,30 @@ typedef enum {
                                             was added for completeness and possible future extensions. */
 } i18n_formattable_type_e;
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_MEASURE_MODULE
+ * @{
+ */
+
 /**
  * @brief Handle to the object that represents an amount of a specified unit.
  * @since_tizen 2.3.2
  */
 typedef void *i18n_measure_h;
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_MEASURE_UNIT_MODULE
+ * @{
+ */
+
 /**
  * @brief Handle to the object that represents a unit such as length, mass, volume, currency, etc.
  * @since_tizen 2.3.2
@@ -2896,14 +2926,13 @@ typedef void *i18n_measure_unit_h;
 typedef bool (*i18n_measure_unit_types_cb)(const char *type_id, void *user_data);
 
 /**
- * @brief Enumeration for the flavor of data type contained within an #i18n_formattable_h object.
- * @since_tizen 2.3.2
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_ALPHABETIC_INDEX_MODULE
+ * @{
  */
-typedef enum {
-    I18N_ULOC_ACTUAL_LOCALE = 0,    /**< This is locale the data actually comes from */
-    I18N_ULOC_VALID_LOCALE = 1,     /**< This is the most specific locale supported by the ICU */
-    I18N_ULOC_REQUESTED_LOCALE = 2, /**< This is the requested locale (deprecated) */
-} i18n_uloc_data_locale_type_e;
 
 /*
  * @brief The Alphabetic index handle.
@@ -2951,7 +2980,16 @@ typedef enum {
 } i18n_alpha_idx_label_type_e;
 
 /**
- * @brief A simple class used by Format and its subclasses to identify fields in formatted output
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_FIELD_POSITION_MODULE
+ * @{
+ */
+
+/**
+ * @brief Handle to the object of class used by the #i18n_format_h and its subclasses to identify fields in a formatted output.
  * @since_tizen 2.3.2
  */
 typedef void *i18n_field_position_h;
@@ -2965,11 +3003,24 @@ typedef enum {
 } i18n_field_position_dont_care_e;
 
 /**
- * @brief A simple class used by Format and its subclasses to identify fields in formatted output.
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_BASE_UTILS_I18N_FIELD_POSITION_MODULE
+ * @{
+ */
+
+/**
+ * @brief Handle to the object used by the Format and its subtypes to keep track of the current position during parsing.
  * @since_tizen 2.3.2
  */
 typedef void *i18n_parse_position_h;
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif
index da645bf1537f74aeeb590ebd6682ec1906f1faf6..a0b1ccda1b0fa179daab93d506390e046c1fcf31 100644 (file)
@@ -126,11 +126,11 @@ int i18n_format_parse_object_with_parse_position(i18n_format_h format, const cha
     return _i18n_error_mapping(status);
 }
 
-int i18n_format_get_locale(i18n_format_h format, i18n_uloc_data_locale_type_e type,
+int i18n_format_get_locale(i18n_format_h format, i18n_ulocale_data_locale_type_e type,
         char **language, char **country)
 {
     retv_if(format == NULL, I18N_ERROR_INVALID_PARAMETER);
-    retv_if(type < I18N_ULOC_ACTUAL_LOCALE || type > I18N_ULOC_REQUESTED_LOCALE, I18N_ERROR_INVALID_PARAMETER);
+    retv_if(type < I18N_ULOCALE_DATA_LOCALE_TYPE_ACTUAL_LOCALE || type > I18N_ULOCALE_DATA_LOCALE_TYPE_VALID_LOCALE, I18N_ERROR_INVALID_PARAMETER);
     retv_if(language == NULL, I18N_ERROR_INVALID_PARAMETER);
     retv_if(country == NULL, I18N_ERROR_INVALID_PARAMETER);
 
index 6cf34b36990e2abd5934af9f371a550887ac31c4..4f058d2d4083a1395f17f93d40893907b725d7bd 100644 (file)
@@ -40,31 +40,31 @@ int i18n_formattable_create_with_udate(i18n_udate date, i18n_formattable_h *form
     return I18N_ERROR_NONE;
 }
 
-int i18n_formattable_create_with_double(double d, i18n_formattable_h *formattable)
+int i18n_formattable_create_with_double(double value, i18n_formattable_h *formattable)
 {
     retv_if(formattable == NULL, I18N_ERROR_INVALID_PARAMETER);
 
-    *formattable = new Formattable(d);
+    *formattable = new Formattable(value);
     retv_if(*formattable == NULL, I18N_ERROR_OUT_OF_MEMORY);
 
     return I18N_ERROR_NONE;
 }
 
-int i18n_formattable_create_with_long(int32_t l, i18n_formattable_h *formattable)
+int i18n_formattable_create_with_long(int32_t value, i18n_formattable_h *formattable)
 {
     retv_if(formattable == NULL, I18N_ERROR_INVALID_PARAMETER);
 
-    *formattable = new Formattable(l);
+    *formattable = new Formattable(value);
     retv_if(*formattable == NULL, I18N_ERROR_OUT_OF_MEMORY);
 
     return I18N_ERROR_NONE;
 }
 
-int i18n_formattable_create_with_int64(int64_t ll, i18n_formattable_h *formattable)
+int i18n_formattable_create_with_int64(int64_t value, i18n_formattable_h *formattable)
 {
     retv_if(formattable == NULL, I18N_ERROR_INVALID_PARAMETER);
 
-    *formattable = new Formattable(ll);
+    *formattable = new Formattable(value);
     retv_if(*formattable == NULL, I18N_ERROR_OUT_OF_MEMORY);
 
     return I18N_ERROR_NONE;
@@ -239,7 +239,7 @@ int i18n_formattable_not_equal(i18n_formattable_h formattable, i18n_formattable_
     retv_if(other == NULL, I18N_ERROR_INVALID_PARAMETER);
     retv_if(not_equal == NULL, I18N_ERROR_INVALID_PARAMETER);
 
-    *not_equal = (bool) (((Formattable *) formattable) != ((Formattable *) other));
+    *not_equal = (bool) (*((Formattable *) formattable) != *((Formattable *) other));
 
     return I18N_ERROR_NONE;
 }
@@ -250,7 +250,7 @@ int i18n_formattable_equal(i18n_formattable_h formattable, i18n_formattable_h ot
     retv_if(other == NULL, I18N_ERROR_INVALID_PARAMETER);
     retv_if(equal == NULL, I18N_ERROR_INVALID_PARAMETER);
 
-    *equal = (bool) (((Formattable *) formattable) == ((Formattable *) other));
+    *equal = (bool) (*((Formattable *) formattable) == *((Formattable *) other));
 
     return I18N_ERROR_NONE;
 }
@@ -263,12 +263,13 @@ int i18n_formattable_element_at(i18n_formattable_h formattable, int32_t index, i
 
     int32_t count;
     UErrorCode status = U_ZERO_ERROR;
+
     ((Formattable *) formattable)->getArray(count, status);
 
     retv_if(status == U_INVALID_FORMAT_ERROR, I18N_ERROR_INVALID_FORMAT);
     retv_if(index >= count, I18N_ERROR_INDEX_OUTOFBOUNDS);
 
-    *element = (i18n_formattable_h) &((Formattable *) formattable)[index];
+    *element = (i18n_formattable_h) &((*((Formattable *) formattable))[index]);
 
     return _i18n_error_mapping(status);
 }
@@ -304,29 +305,29 @@ int i18n_formattable_set_date(i18n_formattable_h formattable, i18n_udate d)
     return I18N_ERROR_NONE;
 }
 
-int i18n_formattable_set_double(i18n_formattable_h formattable, double d)
+int i18n_formattable_set_double(i18n_formattable_h formattable, double value)
 {
     retv_if(formattable == NULL, I18N_ERROR_INVALID_PARAMETER);
 
-    ((Formattable *) formattable)->setDouble(d);
+    ((Formattable *) formattable)->setDouble(value);
 
     return I18N_ERROR_NONE;
 }
 
-int i18n_formattable_set_int64(i18n_formattable_h formattable, int64_t ll)
+int i18n_formattable_set_int64(i18n_formattable_h formattable, int64_t value)
 {
     retv_if(formattable == NULL, I18N_ERROR_INVALID_PARAMETER);
 
-    ((Formattable *) formattable)->setInt64(ll);
+    ((Formattable *) formattable)->setInt64(value);
 
     return I18N_ERROR_NONE;
 }
 
-int i18n_formattable_set_long(i18n_formattable_h formattable, int32_t l)
+int i18n_formattable_set_long(i18n_formattable_h formattable, int32_t value)
 {
     retv_if(formattable == NULL, I18N_ERROR_INVALID_PARAMETER);
 
-    ((Formattable *) formattable)->setLong(l);
+    ((Formattable *) formattable)->setLong(value);
 
     return I18N_ERROR_NONE;
 }