From 2b07ef3e45b759398f5b70d243ce70ce0f0dd773 Mon Sep 17 00:00:00 2001
From: Markus Scherer <markus.icu@gmail.com>
Date: Mon, 2 Jun 2003 16:45:41 +0000
Subject: [PATCH] ICU-2589 Fix some doxygen warnings.

X-SVN-Rev: 12216
---
 icu4c/source/common/unicode/normlzr.h | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/icu4c/source/common/unicode/normlzr.h b/icu4c/source/common/unicode/normlzr.h
index e6129378012..946f4c9ded4 100644
--- a/icu4c/source/common/unicode/normlzr.h
+++ b/icu4c/source/common/unicode/normlzr.h
@@ -464,7 +464,13 @@ public:
   /**
    * Return the next character in the normalized text.
    * (Post-increment semantics.)
-   * If the end of the text has already been reached, {@link #DONE} is returned.
+   * If the end of the text has already been reached, DONE is returned.
+   * The DONE value could be confused with a U+FFFF non-character code point
+   * in the text. If this is possible, you can test getIndex()<endIndex()
+   * before calling next(), or (getIndex()<endIndex() || last()!=DONE)
+   * after calling next(). (Calling last() will change the iterator state!)
+   *
+   * The C API unorm_next() is more efficient and does not have this ambiguity.
    *
    * @return the next normalized code point
    * @stable ICU 2.0
@@ -472,9 +478,15 @@ public:
   UChar32              next(void);
 
   /**
-   * Return the previous character in the normalized text. and decrement
+   * Return the previous character in the normalized text and decrement.
    * (Pre-decrement semantics.)
-   * If the beginning of the text has already been reached, {@link #DONE} is returned.
+   * If the beginning of the text has already been reached, DONE is returned.
+   * The DONE value could be confused with a U+FFFF non-character code point
+   * in the text. If this is possible, you can test
+   * (getIndex()>startIndex() || first()!=DONE). (Calling first() will change
+   * the iterator state!)
+   *
+   * The C API unorm_previous() is more efficient and does not have this ambiguity.
    *
    * @return the previous normalized code point
    * @stable ICU 2.0