AuroraMiddleware/scuffed-code
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ICU-1082 fixed comments some more

Browse Source 
X-SVN-Rev: 9706
This commit is contained in:
Vladimir Weinstein 2002-08-13 23:59:11 +00:00
parent 39416821ae
commit eab27cdaf0
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
icu4c/source/common/unicode/ures.h
View File

@ -308,10 +308,11 @@ ures_getVersion(const UResourceBundle* resB,
UVersionInfo versionInfo);
/**
* Return the name of the Locale associated with this ResourceBundle.
* If opening of a sub resource in a particular bundle results in
* U_USING_FALLBACK_WARNING status, then the locale of the parent bundle is returned.
* If the opening results in U_USING_DEFAULT_WARING then locale of the root bundle is returned.
* Return the name of the Locale associated with this ResourceBundle. This API allows
* you to query for the real locale of the resource. For example, if you requested
* "en_US_CALIFORNIA" and only "en_US" bundle exists, "en_US" will be returned.
* For subresources, the locale where this resource comes from will be returned.
* If fallback has occured, getLocale will reflect this.
* @param resourceBundle: resource bundle in question
* @param status: just for catching illegal arguments
* @return A Locale name
@ -347,6 +348,7 @@ ures_openFillIn(UResourceBundle *r,
* @param len: fills in the length of resulting string
* @param status: fills in the outgoing error code
* could be <TT>U_MISSING_RESOURCE_ERROR</T> if the key is not found
* Always check the value of status. Don't count on returning NULL.
* could be a non-failing error
* e.g.: <TT>U_USING_FALLBACK_ERROR</TT>,<TT>U_USING_DEFAULT_ERROR </TT>
* @return a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file.
@ -368,6 +370,7 @@ ures_getString(const UResourceBundle* resourceBundle,
* @param len: fills in the length of resulting byte chunk
* @param status: fills in the outgoing error code
* could be <TT>U_MISSING_RESOURCE_ERROR</T> if the key is not found
* Always check the value of status. Don't count on returning NULL.
* could be a non-failing error
* e.g.: <TT>U_USING_FALLBACK_ERROR</TT>,<TT>U_USING_DEFAULT_ERROR </TT>
* @return a pointer to a chuck of unsigned bytes which live in a memory mapped/DLL file.
@ -389,9 +392,10 @@ ures_getBinary(const UResourceBundle* resourceBundle,
* @param len: fills in the length of resulting byte chunk
* @param status: fills in the outgoing error code
* could be <TT>U_MISSING_RESOURCE_ERROR</T> if the key is not found
* Always check the value of status. Don't count on returning NULL.
* could be a non-failing error
* e.g.: <TT>U_USING_FALLBACK_ERROR</TT>,<TT>U_USING_DEFAULT_ERROR </TT>
* @return a pointer to a chuck of unsigned bytes which live in a memory mapped/DLL file.
* @return a pointer to a chunk of unsigned bytes which live in a memory mapped/DLL file.
* @see ures_getBinary
* @see ures_getString
* @see ures_getInt
@ -509,7 +513,8 @@ ures_hasNext(UResourceBundle *resourceBundle);
* @param resourceBundle a resource
* @param fillIn if NULL a new UResourceBundle struct is allocated and must be deleted by the caller.
* Alternatively, you can supply a struct to be filled by this function.
* @param status fills in the outgoing error code
* @param status fills in the outgoing error code. You may still get a non NULL result even if an
* error occured. Check status instead.
* @return a pointer to a UResourceBundle struct. If fill in param was NULL, caller must delete it
* @stable
*/
@ -525,7 +530,8 @@ ures_getNextResource(UResourceBundle *resourceBundle,
* @param resourceBundle a resource
* @param len fill in length of the string
* @param key fill in for key associated with this string. NULL if no key
* @param status fills in the outgoing error code
* @param status fills in the outgoing error code. If an error occured, we may return NULL, but don't
* count on it. Check status instead!
* @return a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file.
* @stable
*/
@ -542,7 +548,8 @@ ures_getNextString(UResourceBundle *resourceBundle,
* @param indexR an index to the wanted resource.
* @param fillIn if NULL a new UResourceBundle struct is allocated and must be deleted by the caller.
* Alternatively, you can supply a struct to be filled by this function.
* @param status fills in the outgoing error code
* @param status fills in the outgoing error code. Don't count on NULL being returned if an error has
* occured. Check status instead.
* @return a pointer to a UResourceBundle struct. If fill in param was NULL, caller must delete it
* @stable
*/
@ -558,7 +565,8 @@ ures_getByIndex(const UResourceBundle *resourceBundle,
* @param resourceBundle a resource
* @param indexS an index to the wanted string.
* @param len fill in length of the string
* @param status fills in the outgoing error code
* @param status fills in the outgoing error code. If an error occured, we may return NULL, but don't
* count on it. Check status instead!
* @return a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file.
* @stable
*/
@ -593,9 +601,9 @@ ures_getByKey(const UResourceBundle *resourceBundle,
* @param resB a resource
* @param key a key associated with the wanted string
* @param len fill in length of the string
* @param status fills in the outgoing error code
* @param status fills in the outgoing error code. If an error occured, we may return NULL, but don't
* count on it. Check status instead!
* @return a pointer to a zero-terminated UChar array which lives in a memory mapped/DLL file.
* Can return NULL.
* @stable
*/
U_CAPI const UChar* U_EXPORT2