Index: source/common/unicode/ubrk.h |
diff --git a/source/common/unicode/ubrk.h b/source/common/unicode/ubrk.h |
index 3c26663ec961d983488bced551656bdaad85e705..f43943ed1ab12c1798945dbdea02f9db163d1ab9 100644 |
--- a/source/common/unicode/ubrk.h |
+++ b/source/common/unicode/ubrk.h |
@@ -1,3 +1,5 @@ |
+// Copyright (C) 2016 and later: Unicode, Inc. and others. |
+// License & terms of use: http://www.unicode.org/copyright.html |
/* |
****************************************************************************** |
* Copyright (C) 1996-2015, International Business Machines Corporation and others. |
@@ -70,7 +72,7 @@ |
* "Extended Grapheme Clusters", which are groupings of codepoints |
* that should be treated as character-like units for many text operations. |
* Please see Unicode Standard Annex #29, Unicode Text Segmentation, |
- * http://www.unicode.org/reports/tr29/ for additional information |
+ * http://www.unicode.org/reports/tr29/ for additional information |
* on grapheme clusters and guidelines on their use. |
* <p> |
* Title boundary analysis locates all positions, |
@@ -114,8 +116,12 @@ typedef enum UBreakIteratorType { |
* @deprecated ICU 2.8 Use the word break iterator for titlecasing for Unicode 4 and later. |
*/ |
UBRK_TITLE = 4, |
-#endif /* U_HIDE_DEPRECATED_API */ |
- UBRK_COUNT = 5 |
+ /** |
+ * One more than the highest normal UBreakIteratorType value. |
+ * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420. |
+ */ |
+ UBRK_COUNT = 5 |
+#endif // U_HIDE_DEPRECATED_API |
} UBreakIteratorType; |
/** Value indicating all text boundaries have been returned. |
@@ -130,7 +136,10 @@ typedef enum UBreakIteratorType { |
* word, to allow for further subdivisions of a category in future releases. |
* Applications should check for tag values falling within the range, rather |
* than for single individual values. |
- * @stable ICU 2.2 |
+ * |
+ * The numeric values of all of these constants are stable (will not change). |
+ * |
+ * @stable ICU 2.2 |
*/ |
typedef enum UWordBreak { |
/** Tag value for "words" that do not fit into any of other categories. |
@@ -163,7 +172,10 @@ typedef enum UWordBreak { |
* word, to allow for further subdivisions of a category in future releases. |
* Applications should check for tag values falling within the range, rather |
* than for single individual values. |
- * @stable ICU 2.8 |
+ * |
+ * The numeric values of all of these constants are stable (will not change). |
+ * |
+ * @stable ICU 2.8 |
*/ |
typedef enum ULineBreakTag { |
/** Tag value for soft line breaks, positions at which a line break |
@@ -185,7 +197,10 @@ typedef enum ULineBreakTag { |
* sentence, to allow for further subdivisions of a category in future releases. |
* Applications should check for tag values falling within the range, rather |
* than for single individual values. |
- * @stable ICU 2.8 |
+ * |
+ * The numeric values of all of these constants are stable (will not change). |
+ * |
+ * @stable ICU 2.8 |
*/ |
typedef enum USentenceBreakTag { |
/** Tag value for for sentences ending with a sentence terminator |
@@ -316,7 +331,11 @@ U_NAMESPACE_END |
#endif |
/** |
- * Sets an existing iterator to point to a new piece of text |
+ * Sets an existing iterator to point to a new piece of text. |
+ * The break iterator retains a pointer to the supplied text. |
+ * The caller must not modify or delete the text while the BreakIterator |
+ * retains the reference. |
+ * |
* @param bi The iterator to use |
* @param text The text to be set |
* @param textLength The length of the text |