Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8173425 Javadoc needs a new tag to specify the summary.
  3. JDK-8186403

Release Note: Comment Tag for Summary of an API Description

    XMLWordPrintable

    Details

    • Type: Sub-task
    • Status: Closed
    • Priority: P4
    • Resolution: Delivered
    • Affects Version/s: 10
    • Fix Version/s: 10
    • Component/s: tools
    • Subcomponent:
    • CPU:
      generic
    • OS:
      generic
    • Verification:
      Verified

      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).

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            ksrini Kumar Srinivasan
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: