ICU-57131.0.1.tar.gz

[apple/icu.git] / icuSources / common / unicode / uloc.h

diff --git a/icuSources/common/unicode/uloc.h b/icuSources/common/unicode/uloc.h
index c305c8b78c8a853b938d65d16a1e1296db7737bb..a96b1cd8096ff4ada5e1d11d89878010b3e63784 100644 (file)
--- a/icuSources/common/unicode/uloc.h
+++ b/icuSources/common/unicode/uloc.h
@@ -1,6 +1,6 @@
 /*
 **********************************************************************
-*   Copyright (C) 1997-2014, International Business Machines
+*   Copyright (C) 1997-2016, International Business Machines
 *   Corporation and others.  All Rights Reserved.
 **********************************************************************
 *
@@ -588,6 +588,8 @@ uloc_getDisplayScript(const char* locale,
 
 /**
  * Gets the country name suitable for display for the specified locale.
+ * Warning: this is for the region part of a valid locale ID; it cannot just be the region code (like "FR").
+ * To get the display name for a region alone, or for other options, use ULocaleDisplayNames instead.
  *
  * @param locale the locale to get the displayable country code with. NULL may be used to specify the default.
  * @param displayLocale Specifies the locale to be used to display the name.  In other words,
@@ -767,10 +769,11 @@ uloc_getISOLanguages(void);
 
 /**
  *
- * Gets a list of all available 2-letter country codes defined in ISO 639.  This is a
- * pointer to an array of pointers to arrays of char.  All of these pointers are
- * owned by ICU-- do not delete them, and do not write through them.  The array is
- * terminated with a null pointer.
+ * Gets a list of all available 2-letter country codes which are valid regular
+ * region codes in CLDR; these are based on the non-deprecated alpha-2 region
+ * codes in ISO 3166-1. The return value is a pointer to an array of pointers
+ * C strings.  All of these pointers are owned by ICU; do not delete them, and
+ * do not write through them.  The array is terminated with a null pointer.
  * @return a list of all available country codes
  * @stable ICU 2.0
  */
@@ -886,7 +889,6 @@ uloc_setKeywordValue(const char* keywordName,
                      char* buffer, int32_t bufferCapacity,
                      UErrorCode* status);
 
-#ifndef U_HIDE_DRAFT_API
 /**
  * Returns whether the locale's script is written right-to-left.
  * If there is no script subtag, then the likely script is used, see uloc_addLikelySubtags().
@@ -899,11 +901,10 @@ uloc_setKeywordValue(const char* keywordName,
  *
  * @param locale input locale ID
  * @return TRUE if the locale's script is written right-to-left
- * @draft ICU 54
+ * @stable ICU 54
  */
-U_DRAFT UBool U_EXPORT2
+U_STABLE UBool U_EXPORT2
 uloc_isRightToLeft(const char *locale);
-#endif  /* U_HIDE_DRAFT_API */
 
 /**
  * enums for the  return value for the character and line orientation
@@ -1151,7 +1152,6 @@ uloc_toLanguageTag(const char* localeID,
                    UBool strict,
                    UErrorCode* err);
 
-#ifndef U_HIDE_DRAFT_API
 /**
  * Converts the specified keyword (legacy key, or BCP 47 Unicode locale
  * extension key) to the equivalent BCP 47 Unicode locale extension key.
@@ -1171,9 +1171,9 @@ uloc_toLanguageTag(const char* localeID,
  *                      mapped to a well-formed BCP 47 Unicode locale extension
  *                      key. 
  * @see uloc_toLegacyKey
- * @draft ICU 54
+ * @stable ICU 54
  */
-U_DRAFT const char* U_EXPORT2
+U_STABLE const char* U_EXPORT2
 uloc_toUnicodeLocaleKey(const char* keyword);
 
 /**
@@ -1202,9 +1202,9 @@ uloc_toUnicodeLocaleKey(const char* keyword);
  *                      or NULL if the locale keyword value cannot be mapped to
  *                      a well-formed BCP 47 Unicode locale extension type.
  * @see uloc_toLegacyType
- * @draft ICU 54
+ * @stable ICU 54
  */
-U_DRAFT const char* U_EXPORT2
+U_STABLE const char* U_EXPORT2
 uloc_toUnicodeLocaleType(const char* keyword, const char* value);
 
 /**
@@ -1217,9 +1217,9 @@ uloc_toUnicodeLocaleType(const char* keyword, const char* value);
  * @return              the well-formed legacy key, or NULL if the specified
  *                      keyword cannot be mapped to a well-formed legacy key.
  * @see toUnicodeLocaleKey
- * @draft ICU 54
+ * @stable ICU 54
  */
-U_DRAFT const char* U_EXPORT2
+U_STABLE const char* U_EXPORT2
 uloc_toLegacyKey(const char* keyword);
 
 /**
@@ -1246,11 +1246,9 @@ uloc_toLegacyKey(const char* keyword);
  *                      keyword value cannot be mapped to a well-formed legacy
  *                      type.
  * @see toUnicodeLocaleType
- * @draft ICU 54
+ * @stable ICU 54
  */
-U_DRAFT const char* U_EXPORT2
+U_STABLE const char* U_EXPORT2
 uloc_toLegacyType(const char* keyword, const char* value);
 
-#endif  /* U_HIDE_DRAFT_API */
-
 #endif /*_ULOC*/