-
Bug
-
Resolution: Not an Issue
-
P4
-
1.4.2
-
generic
-
other
There's a "spurious" warning from javadoc concerning breakiterator -
it doesn't like a doc comment that starts:
/**
* {@inheritDoc}
*
* <p>additional text ...
*/
With the -breakiterator option, there is no warning.
Without the -breakiterator option, the warning is:
C.java:8: warning - The first sentence is interpreted to be:
"{@inheritDoc}"
This sentence is different from what will be interpreted as the first sentence
in the next major release (when that interpretation will be internationalized),
which is:
"{@inheritDoc}
<p>additional text ..."
To avoid this note, change the doc comment to make this a proper first sentence,
then use -breakiterator from that point forward, which will output this new
sentence.
it doesn't like a doc comment that starts:
/**
* {@inheritDoc}
*
* <p>additional text ...
*/
With the -breakiterator option, there is no warning.
Without the -breakiterator option, the warning is:
C.java:8: warning - The first sentence is interpreted to be:
"{@inheritDoc}"
This sentence is different from what will be interpreted as the first sentence
in the next major release (when that interpretation will be internationalized),
which is:
"{@inheritDoc}
<p>additional text ..."
To avoid this note, change the doc comment to make this a proper first sentence,
then use -breakiterator from that point forward, which will output this new
sentence.
- relates to
-
JDK-4959985 Javadoc BreakIterator warning is no longer current.
-
- Resolved
-