Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8173425

Javadoc needs a new tag to specify the summary.

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Fixed
    • P3
    • 10
    • 9
    • tools
    • b20
    • generic
    • generic

    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.

      Attachments

        Issue Links

          csr for

          CSR - null JDK-8184034 Provide a new comment tag to specify the summary of an API description.

          • P3 - Major loss of function.
          • Closed
          duplicates

          Enhancement - null JDK-4921374 Add tag to explicitly mark the end of the summary or mark the entire summary

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          relates to

          Bug - A problem which impairs or prevents the functions of the product. JDK-8184683 Add @since tags and default methods for some elements in Compiler Tree API

          • P3 - Major loss of function.
          • Resolved
          There are no Sub-Tasks for this issue.

          Activity

            People

              ksrini Kumar Srinivasan
              ksrini Kumar Srinivasan
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: