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

Javadoc needs a new tag to specify the summary.

    Details

    • Type: Enhancement
    • Status: Resolved
    • Priority: P3
    • Resolution: Fixed
    • Affects Version/s: 9
    • Fix Version/s: 10
    • Component/s: tools
    • Subcomponent:
    • Resolved In Build:
      b20
    • CPU:
      generic
    • OS:
      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.

        Issue Links

          Activity

          Hide
          hgupdate HG Updates added a comment -
          URL: http://hg.openjdk.java.net/jdk10/jdk10/langtools/rev/a6cee0419f93
          User: ksrini
          Date: 2017-08-15 22:23:54 +0000
          Show
          hgupdate HG Updates added a comment - URL: http://hg.openjdk.java.net/jdk10/jdk10/langtools/rev/a6cee0419f93 User: ksrini Date: 2017-08-15 22:23:54 +0000

            People

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

              Dates

              • Created:
                Updated:
                Resolved: