From: Tomasz Bochenski <t.bochenski@samsung.com>
Date: Wed, 21 Sep 2016 12:07:05 +0000 (+0200)
Subject: [Base-utils][Timezone][Ucalendar] Default timezone description fixed.
X-Git-Tag: accepted/tizen/common/20170214.173719~7
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F27%2F89027%2F9;p=platform%2Fcore%2Fapi%2Fbase-utils.git

[Base-utils][Timezone][Ucalendar] Default timezone description fixed.

Change-Id: I3c78f8b00a7159a675d8743e12526c69b2582618
Signed-off-by: Tomasz Bochenski <t.bochenski@samsung.com>
---

diff --git a/src/include/cleaned/utils_i18n_timezone.h b/src/include/cleaned/utils_i18n_timezone.h
index cf43cdc..aa11fc8 100644
--- a/src/include/cleaned/utils_i18n_timezone.h
+++ b/src/include/cleaned/utils_i18n_timezone.h
@@ -208,6 +208,9 @@ int i18n_timezone_get_equivalent_id(const char *timezone_id, int32_t index, char
  * If the system routines fail, or if they specify an i18n_timezone_h or i18n_timezone_h offset
  * which is not recognized, the i18n_timezone_h indicated by the ID kLastResortID
  * is instantiated and made the default.
+ *
+ * This function determines the default timezone by querying the system once and storing the
+ * obtained timezone as default until the application terminates.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[out] timezone A default i18n_timezone_h. Clients are responsible for deleting the time zone object returned.
diff --git a/src/include/deprecated/utils_i18n_timezone.h b/src/include/deprecated/utils_i18n_timezone.h
index c288412..f18ecde 100644
--- a/src/include/deprecated/utils_i18n_timezone.h
+++ b/src/include/deprecated/utils_i18n_timezone.h
@@ -209,6 +209,9 @@ int i18n_timezone_get_equivalent_id(const char *timezone_id, int32_t index, char
  * If the system routines fail, or if they specify an i18n_timezone_h or i18n_timezone_h offset
  * which is not recognized, the i18n_timezone_h indicated by the ID kLastResortID
  * is instantiated and made the default.
+ *
+ * This function determines the default timezone by querying the system once and storing the
+ * obtained timezone as default until the application terminates.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[out] timezone A default i18n_timezone_h. Clients are responsible for deleting the time zone object returned.
diff --git a/src/include/utils_i18n_timezone.h b/src/include/utils_i18n_timezone.h
index 3488b02..ddedd74 100644
--- a/src/include/utils_i18n_timezone.h
+++ b/src/include/utils_i18n_timezone.h
@@ -208,6 +208,9 @@ int i18n_timezone_get_equivalent_id(const char *timezone_id, int32_t index, char
  * If the system routines fail, or if they specify an i18n_timezone_h or i18n_timezone_h offset
  * which is not recognized, the i18n_timezone_h indicated by the ID kLastResortID
  * is instantiated and made the default.
+ *
+ * This function determines the default timezone by querying the system once and storing the
+ * obtained timezone as default until the application terminates.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[out] timezone A default i18n_timezone_h. Clients are responsible for deleting the time zone object returned.
diff --git a/src/include/utils_i18n_ucalendar.h b/src/include/utils_i18n_ucalendar.h
index dbd8195..181eb18 100644
--- a/src/include/utils_i18n_ucalendar.h
+++ b/src/include/utils_i18n_ucalendar.h
@@ -469,16 +469,22 @@ int i18n_ucalendar_timezones_create(i18n_uenumeration_h *enumeration);
 int i18n_ucalendar_country_timezones_create(const char *country, i18n_uenumeration_h *enumeration);
 
 /**
- * @brief Returns the default time zone.
- * @details The default is determined initially by querying the host operating system.
- *		It may be changed with i18n_ucalendar_set_default_timezone()
- *		or with the C++ TimeZone API.
+ * @brief Returns the default time zone (i.e., the one returned by the
+ *        i18n_timezone_create_default() function).
+ * @details The default time zone is determined initially by querying the host operating
+ *      system and storing the obtained time zone as default until the application terminates.
+ *      Therefore, if the time zone is changed after the first call, subsequent calls will not
+ *      reflect the change, i.e. the returned time zone will be the same as for the first function
+ *      call.
+ *
+ *      The default time zone may be changed with i18n_ucalendar_set_default_timezone()
+ *      or with the i18n Timezone API.
  * @remarks The specific error code can be obtained using the get_last_result()
- *		method. Error codes are described in #i18n_error_code_e description.
+ *      method. Error codes are described in #i18n_error_code_e description.
  * @since_tizen 2.3.1
  *
  * @param[out] result A buffer to receive the result, or @c NULL
- * @param[in]	  result_capacity The capacity of the @c result buffer
+ * @param[in]     result_capacity The capacity of the @c result buffer
  *
  * @return The @c result string length, not including the terminating @c NULL.
  * @exception #I18N_ERROR_NONE Successful