JDK-8186403 : Release Note: Comment Tag for Summary of an API Description
- Type: Sub-task
- Component: tools
- Sub-Component: javadoc(tool)
- Affected Version: 10
- Priority: P4
- Status: Closed
- Resolution: Delivered
- OS: generic
- CPU: generic
- Submitted: 2017-08-17
- Updated: 2019-04-09
- Resolved: 2017-08-18
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.
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 |
|---|
10Resolved  |
Description
A new inline tag, `{@summary ...}`, has been added to explicitly specify the text used as the summary of the API description. By default, the summary of an API description is inferred from the first sentence. This is determined by using either a simple algorithm or `java.text.BreakIterator`. However, the heuristics for this are not always correct and can lead to an incorrect determination of the end of the first sentence. The new tag enables the API summary text to be explicitly set instead of inferred.
Please refer to [Documentation Comment Specification for the Standard Doclet](http://docs.oracle.com/javase/10/docs/specs/doc-comment-spec.html).