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

ICU-2806 API Docs added to RuleBasedBreakIterator::getRuleStatus()

Browse source 
X-SVN-Rev: 12163
This commit is contained in:
Andy Heninger 2003-05-29 18:51:43 +00:00
parent bf36a0b93d
commit b863c89a61
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
icu4c/source/common/unicode/rbbi.h
View file

@ -330,8 +330,20 @@ public:
* returned break position. The values appear in the rule source
* within brackets, {123}, for example. For rules that do not specify a
* status, a default value of 0 is returned.
* <p>
* Of the standard types of ICU break iterators, only the word break
* iterator provides status values. The values are defined in
* <code>enum UWordBreak</code>, and allow distinguishing between words
* that contain alphabetic letters, "words" that appear to be numbers,
* punctuation and spaces, words containing ideographic characters, and
* more. Call <code>getRuleStatus</code> after obtaining a boundary
* position from <code>next()<code>, <code>previous()</code>, or
* any other break iterator functions that returns a boundary position.
* <p>
* @return the status from the break rule that determined the most recently
* returned break position.
*
* @see UWordBreak
* @draft ICU 2.2
*/
virtual int32_t getRuleStatus() const;