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

Add tag to explicitly mark the end of the summary or mark the entire summary

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Duplicate
    • P4
    • 10
    • 1.4.2, 5.0
    • tools
    • generic, x86
    • other, windows_xp

    Description

      We need a way to explicitly mark a doc comment summary ("first
      sentence") break at an odd place. This will help with the transition
      from -breakiterator option (in 1.4.0) to it being the default in 1.5.0.

      The summary is the description that appears in the table listing
      the packages. classes or members.

      One possible solution is an inline {@summaryBreak} tag.
      Note that {@summaryBreak} does not necessarily indicate the end of
      the first sentence -- using it would make it possible to include two (or more)
      sentences in the summary.

      Another possible solution is a pair of block tags: @summary and @description.
      These would provide even greater flexibility, allowing the full description
      to begin with something other than the summary sentence.

      Attachments

        Issue Links

          duplicates

          Enhancement - null JDK-8173425 Javadoc needs a new tag to specify the summary.

          • P3 - Major loss of function.
          • Resolved

          Enhancement - null JDK-4935515 Cannot override Javadoc's sentence bounary algorithm

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

          Bug - A problem which impairs or prevents the functions of the product. JDK-4890489 -breakiterator should be the default (possibly only) option

          • P3 - Major loss of function.
          • Closed

          Bug - A problem which impairs or prevents the functions of the product. JDK-4959985 Javadoc BreakIterator warning is no longer current.

          • P3 - Major loss of function.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JDK-4959973 please warn when I don't use @summary

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

          Bug - A problem which impairs or prevents the functions of the product. JDK-4902492 javadoc is throwing breakiterator warnings at '?' on java.lang.Exception

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

          Activity

            People

              ksrini Kumar Srinivasan
              dkramersunw Douglas Kramer (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                Imported:
                Indexed: