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

ICU-8914 extra C/C++ documentation for collation reordering

Browse Source 
X-SVN-Rev: 31002
This commit is contained in:
Stuart Gill 2011-12-01 23:13:47 +00:00
parent 77b94f2bd1
commit 16ea5c24a6
2 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
icu4c/source/i18n/unicode/coll.h
View File

@ -608,6 +608,8 @@ public:
* @see ucol_setReorderCodes
* @see Collator#getEquivalentReorderCodes
* @see Collator#setReorderCodes
* @see UScriptCode
* @see UColReorderCode
* @draft ICU 4.8
*/
virtual int32_t U_EXPORT2 getReorderCodes(int32_t *dest,
@ -616,12 +618,16 @@ public:
/**
* Sets the ordering of scripts for this collator.
*
* <p>The reordering codes are a combination of script codes and reorder codes.
* @param reorderCodes An array of script codes in the new order. This can be NULL if the
* length is also set to 0. An empty array will clear any reordering codes on the collator.
* @param reorderCodesLength The length of reorderCodes.
* @param status error code
* @see Collator#getReorderCodes
* @see Collator#getEquivalentReorderCodes
* @param status error code
* @see UScriptCode
* @see UColReorderCode
* @draft ICU 4.8
*/
virtual void U_EXPORT2 setReorderCodes(const int32_t* reorderCodes,
@ -642,6 +648,8 @@ public:
* @see ucol_setReorderCodes
* @see Collator#getReorderCodes
* @see Collator#setReorderCodes
* @see UScriptCode
* @see UColReorderCode
* @draft ICU 4.8
*/
static int32_t U_EXPORT2 getEquivalentReorderCodes(int32_t reorderCode,

20
icu4c/source/i18n/unicode/ucol.h
View File

@ -140,6 +140,7 @@ typedef enum {
* @see ucol_getReorderCodes
* @see ucol_setReorderCodes
* @see ucol_getEquivalentReorderCodes
* @see UScriptCode
* @draft ICU 4.8
*/
typedef enum {
@ -163,36 +164,43 @@ typedef enum {
UCOL_REORDER_CODE_OTHERS = USCRIPT_UNKNOWN,
/**
* Characters with the space property.
* This is equivalent to the rule value "space".
* @draft ICU 4.8
*/
UCOL_REORDER_CODE_SPACE = 0x1000,
/**
* The first entry in the enumeration of reordering groups.
* The first entry in the enumeration of reordering groups. This is intended for use in
* range checking and enumeration of the reorder codes.
* @draft ICU 4.8
*/
UCOL_REORDER_CODE_FIRST = UCOL_REORDER_CODE_SPACE,
/**
* Characters with the punctuation property.
* This is equivalent to the rule value "punct".
* @draft ICU 4.8
*/
UCOL_REORDER_CODE_PUNCTUATION = 0x1001,
/**
* Characters with the symbol property.
* This is equivalent to the rule value "symbol".
* @draft ICU 4.8
*/
UCOL_REORDER_CODE_SYMBOL = 0x1002,
/**
* Characters with the currency property.
* This is equivalent to the rule value "currency".
* @draft ICU 4.8
*/
UCOL_REORDER_CODE_CURRENCY = 0x1003,
/**
* Characters with the digit property.
* This is equivalent to the rule value "digit".
* @draft ICU 4.8
*/
UCOL_REORDER_CODE_DIGIT = 0x1004,
/**
* The limit of the reorder codes.
* The limit of the reorder codes. This is intended for use in range checking
* and enumeration of the reorder codes.
* @draft ICU 4.8
*/
UCOL_REORDER_CODE_LIMIT = 0x1005
@ -603,6 +611,8 @@ ucol_setStrength(UCollator *coll,
* @return The number of reordering codes written to the dest array.
* @see ucol_setReorderCodes
* @see ucol_getEquivalentReorderCodes
* @see UScriptCode
* @see UColReorderCode
* @draft ICU 4.8
*/
U_DRAFT int32_t U_EXPORT2
@ -631,7 +641,7 @@ ucol_getReorderCodes(const UCollator* coll,
* DEFAULT code <b>must</b> be the sole code supplied when it used. If not
* that will result in an U_ILLEGAL_ARGUMENT_ERROR being set.
* <p>The special reorder code NONE will remove any reordering for this collator.
* The result of setting no reordering will be to have the DUCET/CLDR reordering used. The
* The result of setting no reordering will be to have the DUCET/CLDR ordering used. The
* NONE code <b>must</b> be the sole code supplied when it used.
* @param coll The UCollator to set.
* @param reorderCodes An array of script codes in the new order. This can be NULL if the
@ -641,6 +651,8 @@ ucol_getReorderCodes(const UCollator* coll,
* failure before the function call.
* @see ucol_getReorderCodes
* @see ucol_getEquivalentReorderCodes
* @see UScriptCode
* @see UColReorderCode
* @draft ICU 4.8
*/
U_DRAFT void U_EXPORT2
@ -661,6 +673,8 @@ ucol_setReorderCodes(UCollator* coll,
* @return The number of reordering codes written to the dest array.
* @see ucol_setReorderCodes
* @see ucol_getReorderCodes
* @see UScriptCode
* @see UColReorderCode
* @draft ICU 4.8
*/
U_DRAFT int32_t U_EXPORT2