ICU-8777 Fixed API doc for createTimeZone. Updated the description to explain the case for bad time zone ID - using Etc/Unknown instead of Etc/GMT as fallback zone ID.

X-SVN-Rev: 30620
This commit is contained in:
Yoshito Umaoka 2011-09-06 18:44:49 +00:00
parent de229aa8da
commit 50758756b5
2 changed files with 8 additions and 7 deletions

View File

@ -139,10 +139,10 @@ public:
* Creates a <code>TimeZone</code> for the given ID. * Creates a <code>TimeZone</code> for the given ID.
* @param ID the ID for a <code>TimeZone</code>, such as "America/Los_Angeles", * @param ID the ID for a <code>TimeZone</code>, such as "America/Los_Angeles",
* or a custom ID such as "GMT-8:00". * or a custom ID such as "GMT-8:00".
* @return the specified <code>TimeZone</code>, or the GMT zone if the given ID * @return the specified <code>TimeZone</code>, or the GMT zone with ID
* cannot be understood. Return result guaranteed to be non-null. If you * <code>UCAL_UNKNOWN_ZONE_ID</code> ("Etc/Unknown") if the given ID cannot be understood.
* require that the specific zone asked for be returned, check the ID of the * Return result guaranteed to be non-null. If you require that the specific zone asked
* return result. * for be returned, check the ID of the return result.
* @stable ICU 2.0 * @stable ICU 2.0
*/ */
static TimeZone* U_EXPORT2 createTimeZone(const UnicodeString& ID); static TimeZone* U_EXPORT2 createTimeZone(const UnicodeString& ID);

View File

@ -670,9 +670,9 @@ ucal_getNow(void);
* month, and day. * month, and day.
* <p> * <p>
* Note: When unknown TimeZone ID is specified, the UCalendar returned * Note: When unknown TimeZone ID is specified, the UCalendar returned
* by the function is initialized with GMT ("Etc/GMT") without any * by the function is initialized with GMT zone with TimeZone ID <code>UCAL_UNKNOWN_ZONE_ID</code>
* errors/warnings. If you want to check if a TimeZone ID is valid, * ("Etc/Unknown") without any errors/warnings. If you want to check if a TimeZone ID is valid
* use ucal_getCanonicalTimeZoneID prior to this function. * prior to this function, use <code>ucal_getCanonicalTimeZoneID</code>.
* *
* @param zoneID The desired TimeZone ID. If 0, use the default time zone. * @param zoneID The desired TimeZone ID. If 0, use the default time zone.
* @param len The length of zoneID, or -1 if null-terminated. * @param len The length of zoneID, or -1 if null-terminated.
@ -684,6 +684,7 @@ ucal_getNow(void);
* and then pass the locale to ucal_open with UCAL_DEFAULT as the type. * and then pass the locale to ucal_open with UCAL_DEFAULT as the type.
* @param status A pointer to an UErrorCode to receive any errors * @param status A pointer to an UErrorCode to receive any errors
* @return A pointer to a UCalendar, or 0 if an error occurred. * @return A pointer to a UCalendar, or 0 if an error occurred.
* @see #UCAL_UNKNOWN_ZONE_ID
* @stable ICU 2.0 * @stable ICU 2.0
*/ */
U_STABLE UCalendar* U_EXPORT2 U_STABLE UCalendar* U_EXPORT2