Name: nl37777 Date: 10/06/98


The wording of the field description for
java.text.CharacterIterator.DONE doesn't quite
seem to have been written with Javadoc comment
extraction fully in mind.

It says:

  public static final char DONE

     Constant that is returned when the iterator
     has reached either the end or the beginning
     of the text. The unicode 2.0 standard states
     that '\\uFFFF' is an invalid unicode value
     and should not occur in any valid unicode
     string.


It appears that the programmer or document wrote
that text forgetting that the value of the constant
is not visible in JavaDoc. (The programmer might
have been documenting a design decision for future
maintenance programmers to read, but then it possibly
shouldn't be in a public Javadoc comment.)

I would think that you want this comment to mention
that DONE's value is '\uFFFF' so that sentence about
the what the Unicode standard says about '\uFFFF'
doesn't come so unexpectedly.


DSB/DFI
(Review ID: 39847)
======================================================================