organicmaps/icu
13
Fork 0
mirror of https://github.com/unicode-org/icu.git synced 2025-04-20 20:19:32 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions 1

ICU-3406 API docs fixes

Browse source 
X-SVN-Rev: 18035
This commit is contained in:
Steven R. Loomis 2005-06-24 22:02:42 +00:00
parent 1e420e5cbb
commit 79d716f43a
3 changed files with 49 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
icu4c/source/common/unicode/resbund.h
View file

@ -80,13 +80,11 @@ public:
/**
* Constructor
*
* @param path This is a full pathname in the platform-specific format for the
* directory containing the resource data files we want to load
* resources from. We use locale IDs to generate filenames, and the
* filenames have this string prepended to them before being passed
* to the C++ I/O functions. Therefore, this string must always end
* with a directory delimiter (whatever that is for the target OS)
* for this class to work correctly.
* @param packageName The packageName and locale together point to an ICU udata object,
* as defined by <code> udata_open( packageName, "res", locale, err) </code>
* or equivalent. Typically, packageName will refer to a (.dat) file, or to
* a package registered with udata_setAppData(). Using a full file or directory
* pathname for packageName is deprecated.
* @param locale This is the locale this resource bundle is for. To get resources
* for the French locale, for example, you would create a
* ResourceBundle passing Locale::FRENCH for the "locale" parameter,
@ -105,22 +103,26 @@ public:
* fall back locales could be found.
* @stable ICU 2.0
*/
ResourceBundle(const UnicodeString& path,
ResourceBundle(const UnicodeString& packageName,
const Locale& locale,
UErrorCode& err);
/**
* Construct a resource bundle for the root bundle in the specified path.
* Construct a resource bundle for the default bundle in the specified package.
*
* @param path A path/basename for the data file(s) containing the bundle.
* @param packageName The packageName and locale together point to an ICU udata object,
* as defined by <code> udata_open( packageName, "res", locale, err) </code>
* or equivalent. Typically, packageName will refer to a (.dat) file, or to
* a package registered with udata_setAppData(). Using a full file or directory
* pathname for packageName is deprecated.
* @param err A UErrorCode value
* @stable ICU 2.0
*/
ResourceBundle(const UnicodeString& path,
ResourceBundle(const UnicodeString& packageName,
UErrorCode& err);
/**
* Construct a resource bundle for the ICU root bundle.
* Construct a resource bundle for the ICU default bundle.
*
* @param err A UErrorCode value
* @stable ICU 2.0
@ -129,15 +131,19 @@ public:
/**
* Standard constructor, onstructs a resource bundle for the locale-specific
* bundle in the specified path.
* bundle in the specified package.
*
* @param path A path/basename for the data file(s) containing the bundle.
* NULL is used for ICU data.
* @param packageName The packageName and locale together point to an ICU udata object,
* as defined by <code> udata_open( packageName, "res", locale, err) </code>
* or equivalent. Typically, packageName will refer to a (.dat) file, or to
* a package registered with udata_setAppData(). Using a full file or directory
* pathname for packageName is deprecated.
* NULL is used to refer to ICU data.
* @param locale The locale for which to open a resource bundle.
* @param err A UErrorCode value
* @stable ICU 2.0
*/
ResourceBundle(const char* path,
ResourceBundle(const char* packageName,
const Locale& locale,
UErrorCode& err);

2
icu4c/source/common/unicode/ucnv.h
View file

@ -410,7 +410,7 @@ ucnv_openCCSID(int32_t codepage,
* <p>The packageName and converterName must point to an ICU udata object, as defined by
* <code> udata_open( packageName, "cnv", converterName, err) </code> or equivalent.
* Typically, packageName will refer to a (.dat) file, or to a package registered with
* udata_setAppData().</p>
* udata_setAppData(). Using a full file or directory pathname for packageName is deprecated.</p>
*
* <p>The name will NOT be looked up in the alias mechanism, nor will the converter be
* stored in the converter cache or the alias table. The only way to open further converters

44
icu4c/source/common/unicode/ures.h
View file

@ -141,10 +141,11 @@ typedef enum {
* their corresponding keys.
* Note that the caller is responsible of calling <TT>ures_close</TT> on each succesfully
* opened resource bundle.
* @param path string containing the full path pointing to the directory
* where the resources reside followed by the package name
* e.g. "/usr/resource/my_app/resources/guimessages" on a Unix system.
* if NULL, ICU default data files will be used.
* @param packageName The packageName and locale together point to an ICU udata object,
* as defined by <code> udata_open( packageName, "res", locale, err) </code>
* or equivalent. Typically, packageName will refer to a (.dat) file, or to
* a package registered with udata_setAppData(). Using a full file or directory
* pathname for packageName is deprecated. If NULL, ICU data will be used.
* @param locale specifies the locale for which we want to open the resource
* if NULL, the default locale will be used. If strlen(locale) == 0
* root locale will be used.
@ -164,7 +165,7 @@ typedef enum {
* @stable ICU 2.0
*/
U_STABLE UResourceBundle* U_EXPORT2
ures_open(const char* path,
ures_open(const char* packageName,
const char* locale,
UErrorCode* status);
@ -172,10 +173,11 @@ ures_open(const char* path,
/** This function does not care what kind of localeID is passed in. It simply opens a bundle with
* that name. Fallback mechanism is disabled for the new bundle. If the requested bundle contains
* an %%ALIAS directive, the results are undefined.
* @param path string containing the full path pointing to the directory
* where the resources reside followed by the package name
* e.g. "/usr/resource/my_app/resources/guimessages" on a Unix system.
* if NULL, ICU default data files will be used.
* @param packageName The packageName and locale together point to an ICU udata object,
* as defined by <code> udata_open( packageName, "res", locale, err) </code>
* or equivalent. Typically, packageName will refer to a (.dat) file, or to
* a package registered with udata_setAppData(). Using a full file or directory
* pathname for packageName is deprecated. If NULL, ICU data will be used.
* @param locale specifies the locale for which we want to open the resource
* if NULL, the default locale will be used. If strlen(locale) == 0
* root locale will be used.
@ -186,7 +188,7 @@ ures_open(const char* path,
* @stable ICU 2.0
*/
U_STABLE UResourceBundle* U_EXPORT2
ures_openDirect(const char* path,
ures_openDirect(const char* packageName,
const char* locale,
UErrorCode* status);
@ -195,8 +197,11 @@ ures_openDirect(const char* path,
* This path will be converted to char * using the default converter,
* then ures_open() is called.
*
* @param path string containing the full path pointing to the directory
* where the resources reside followed by the package name
* @param packageName The packageName and locale together point to an ICU udata object,
* as defined by <code> udata_open( packageName, "res", locale, err) </code>
* or equivalent. Typically, packageName will refer to a (.dat) file, or to
* a package registered with udata_setAppData(). Using a full file or directory
* pathname for packageName is deprecated. If NULL, ICU data will be used.
* @param locale specifies the locale for which we want to open the resource
* if NULL, the default locale will be used. If strlen(locale) == 0
* root locale will be used.
@ -206,7 +211,7 @@ ures_openDirect(const char* path,
* @stable ICU 2.0
*/
U_STABLE UResourceBundle* U_EXPORT2
ures_openU(const UChar* path,
ures_openU(const UChar* packageName,
const char* locale,
UErrorCode* status);
@ -308,8 +313,11 @@ ures_getLocaleByType(const UResourceBundle* resourceBundle,
* TODO need to revisit usefulness of this function
* and usage model for fillIn parameters without knowing sizeof(UResourceBundle)
* @param r The resourcebundle to open
* @param path String containing the full path pointing to the directory
* where the resources reside followed by the package name
* @param packageName The packageName and locale together point to an ICU udata object,
* as defined by <code> udata_open( packageName, "res", locale, err) </code>
* or equivalent. Typically, packageName will refer to a (.dat) file, or to
* a package registered with udata_setAppData(). Using a full file or directory
* pathname for packageName is deprecated. If NULL, ICU data will be used.
* @param localeID specifies the locale for which we want to open the resource
* @param status The error code
* @return a newly allocated resource bundle or NULL if it doesn't exist.
@ -317,7 +325,7 @@ ures_getLocaleByType(const UResourceBundle* resourceBundle,
*/
U_INTERNAL void U_EXPORT2
ures_openFillIn(UResourceBundle *r,
const char* path,
const char* packageName,
const char* localeID,
UErrorCode* status);
@ -706,13 +714,13 @@ ures_getByKeyWithFallback(const UResourceBundle *resB,
/**
* Create a string enumerator, owned by the caller, of all locales located within
* the specified resource tree.
* @param path path to the tree, such as (NULL) or U_ICUDATA_ALIAS or or "ICUDATA-coll"
* @param packageName name of the tree, such as (NULL) or U_ICUDATA_ALIAS or or "ICUDATA-coll"
* This call is similar to uloc_getAvailable().
* @param status error code
* @draft ICU 3.2
*/
U_DRAFT UEnumeration* U_EXPORT2
ures_openAvailableLocales(const char *path, UErrorCode *status);
ures_openAvailableLocales(const char *packageName, UErrorCode *status);
#endif /*_URES*/