ICU 56 update step 1

source/i18n/unicode/coll.h

 /*
 ******************************************************************************
-*   Copyright (C) 1996-2014, International Business Machines
+*   Copyright (C) 1996-2015, International Business Machines
 *   Corporation and others.  All Rights Reserved.
 ******************************************************************************
 */
 
 /**
  * \file 
  * \brief C++ API: Collation Service.
  */
  
 /**
@@ skipping 586 matching lines @@
      * @see Collator#getStrength
      * @param newStrength the new comparison level.
      * @deprecated ICU 2.6 Use setAttribute(UCOL_STRENGTH...) instead
      */
     virtual void setStrength(ECollationStrength newStrength);
 
     /**
      * Retrieves the reordering codes for this collator.
      * @param dest The array to fill with the script ordering.
      * @param destCapacity The length of dest. If it is 0, then dest may be NULL and the function
-     *  will only return the length of the result without writing any of the result string (pre-flighting).
+     *  will only return the length of the result without writing any codes (pre-flighting).
      * @param status A reference to an error code value, which must not indicate
      * a failure before the function call.
      * @return The length of the script ordering array.
      * @see ucol_setReorderCodes
      * @see Collator#getEquivalentReorderCodes
      * @see Collator#setReorderCodes
      * @see UScriptCode
      * @see UColReorderCode
      * @stable ICU 4.8 
      */
      virtual int32_t getReorderCodes(int32_t *dest,
                                      int32_t destCapacity,
                                      UErrorCode& status) const;
 
     /**
      * 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 ucol_setReorderCodes
      * @see Collator#getReorderCodes
      * @see Collator#getEquivalentReorderCodes
      * @see UScriptCode
      * @see UColReorderCode
      * @stable ICU 4.8 
      */
      virtual void setReorderCodes(const int32_t* reorderCodes,
                                   int32_t reorderCodesLength,
                                   UErrorCode& status) ;
 
     /**
      * Retrieves the reorder codes that are grouped with the given reorder code. Some reorder
      * codes will be grouped and must reorder together.
+     * Beginning with ICU 55, scripts only reorder together if they are primary-equal,
+     * for example Hiragana and Katakana.
+     *
      * @param reorderCode The reorder code to determine equivalence for. 
      * @param dest The array to fill with the script equivalence reordering codes.
      * @param destCapacity The length of dest. If it is 0, then dest may be NULL and the 
-     * function will only return the length of the result without writing any of the result 
-     * string (pre-flighting).
+     * function will only return the length of the result without writing any codes (pre-flighting).
      * @param status A reference to an error code value, which must not indicate 
      * a failure before the function call.
      * @return The length of the of the reordering code equivalence array.
      * @see ucol_setReorderCodes
      * @see Collator#getReorderCodes
      * @see Collator#setReorderCodes
      * @see UScriptCode
      * @see UColReorderCode
      * @stable ICU 4.8 
      */
@@ skipping 198 matching lines @@
      * Universal attribute getter
      * @param attr attribute type
      * @param status to indicate whether the operation went on smoothly or
      *        there were errors
      * @return attribute value
      * @stable ICU 2.2
      */
     virtual UColAttributeValue getAttribute(UColAttribute attr,
                                             UErrorCode &status) const = 0;
 
-    /* Cannot use #ifndef U_HIDE_DRAFT_API for the following draft methods since they are virtual */
     /**
      * Sets the variable top to the top of the specified reordering group.
      * The variable top determines the highest-sorting character
      * which is affected by UCOL_ALTERNATE_HANDLING.
      * If that attribute is set to UCOL_NON_IGNORABLE, then the variable top has no effect.
      *
      * The base class implementation sets U_UNSUPPORTED_ERROR.
      * @param group one of UCOL_REORDER_CODE_SPACE, UCOL_REORDER_CODE_PUNCTUATION,
      *              UCOL_REORDER_CODE_SYMBOL, UCOL_REORDER_CODE_CURRENCY;
      *              or UCOL_REORDER_CODE_DEFAULT to restore the default max variable group
      * @param errorCode Standard ICU error code. Its input value must
      *                  pass the U_SUCCESS() test, or else the function returns
      *                  immediately. Check for U_FAILURE() on output or use with
      *                  function chaining. (See User Guide for details.)
      * @return *this
      * @see getMaxVariable
-     * @draft ICU 53
+     * @stable ICU 53
      */
     virtual Collator &setMaxVariable(UColReorderCode group, UErrorCode &errorCode);
 
     /**
      * Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING.
      *
      * The base class implementation returns UCOL_REORDER_CODE_PUNCTUATION.
      * @return the maximum variable reordering group.
      * @see setMaxVariable
-     * @draft ICU 53
+     * @stable ICU 53
      */
     virtual UColReorderCode getMaxVariable() const;
 
     /**
      * Sets the variable top to the primary weight of the specified string.
      *
      * Beginning with ICU 53, the variable top is pinned to
      * the top of one of the supported reordering groups,
      * and it must not be beyond the last of those groups.
      * See setMaxVariable().
@@ skipping 351 matching lines @@
 };
 #endif /* UCONFIG_NO_SERVICE */
 
 // Collator inline methods -----------------------------------------------
 
 U_NAMESPACE_END
 
 #endif /* #if !UCONFIG_NO_COLLATION */
 
 #endif