-
Enhancement
-
Resolution: Duplicate
-
P4
-
1.4.2, 5.0
-
generic, x86
-
other, windows_xp
We need a way to explicitly mark a doc comment summary ("first
sentence") break at an odd place. This will help with the transition
from -breakiterator option (in 1.4.0) to it being the default in 1.5.0.
The summary is the description that appears in the table listing
the packages. classes or members.
One possible solution is an inline {@summaryBreak} tag.
Note that {@summaryBreak} does not necessarily indicate the end of
the first sentence -- using it would make it possible to include two (or more)
sentences in the summary.
Another possible solution is a pair of block tags: @summary and @description.
These would provide even greater flexibility, allowing the full description
to begin with something other than the summary sentence.
sentence") break at an odd place. This will help with the transition
from -breakiterator option (in 1.4.0) to it being the default in 1.5.0.
The summary is the description that appears in the table listing
the packages. classes or members.
One possible solution is an inline {@summaryBreak} tag.
Note that {@summaryBreak} does not necessarily indicate the end of
the first sentence -- using it would make it possible to include two (or more)
sentences in the summary.
Another possible solution is a pair of block tags: @summary and @description.
These would provide even greater flexibility, allowing the full description
to begin with something other than the summary sentence.
- duplicates
-
-
- Resolved
-
-
-
- Closed
-
- relates to
-
JDK-4890489 -breakiterator should be the default (possibly only) option
-
- Closed
-
-
-
- Resolved
-
-
-
- Closed
-
-
-
- Closed
-
(1 relates to)