JDK-8173425 : Javadoc needs a new tag to specify the summary.
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 9
  • Priority: P3
  • Status: Resolved
  • Resolution: Fixed
  • OS: generic
  • CPU: generic
  • Submitted: 2017-01-27
  • Updated: 2018-02-08
  • Resolved: 2017-08-15
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 10
10 b20Fixed
Related Reports
CSR :  
JDK-8184034 - Provide a new comment tag to specify the summary of an API description.
Duplicate :  
JDK-4921374 - Add tag to explicitly mark the end of the summary or mark the entire summary
Relates :  
JDK-8184683 - Add @since tags and default methods for some elements in Compiler Tree API
Sub Tasks
JDK-8186403 :  
Release Note: Comment Tag for Summary of an API Description - Closed
Description
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.