-
Enhancement
-
Resolution: Fixed
-
P3
-
9
-
b20
-
generic
-
generic
Currently in javadoc the summary (firstsentence) of an element is deciphered by a dot-space rule, or if required using BreakIterator.
It is hard to sometimes guess the users intention, and BreakIterator
can be complex and slow when used with other languages, which does not use the English grammar rules.
For all the reasons, instead of guessing the intentions we should provide a new tag ex:
{@summary This is the first sentence.} This is the second sentence.
Then it becomes crystal clear what the summary sentence(s) should be.
It is hard to sometimes guess the users intention, and BreakIterator
can be complex and slow when used with other languages, which does not use the English grammar rules.
For all the reasons, instead of guessing the intentions we should provide a new tag ex:
{@summary This is the first sentence.} This is the second sentence.
Then it becomes crystal clear what the summary sentence(s) should be.
- csr for
-
JDK-8184034 Provide a new comment tag to specify the summary of an API description.
-
- Closed
-
- duplicates
-
-
- Closed
-
- relates to
-
JDK-8184683 Add @since tags and default methods for some elements in Compiler Tree API
-
- Resolved
-
1.
|
Release Note: Comment Tag for Summary of an API Description |
|
Closed | Unassigned |