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

Update doc comments for improved processing by the Standard Doclet

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: P5
    • Resolution: Fixed
    • Affects Version/s: 15
    • Fix Version/s: 15
    • Component/s: core-libs
    • Labels:
      None
    • Resolved In Build:
      b24

      Description

      The Standard Doclet (i.e vanilla JavaDoc) extracts summaries from doc comments to place them on documentation pages to assist quick scans by humans (think Table of Contents with descriptive headings). Since the Standard Doclet does not understand the meaning of doc comments, to extract a summary it relies on a convention that the first sentence of a doc comment is that doc comment's summary. The problem is that sometimes the doclet gets that first sentence wrong.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                prappo Pavel Rappo
                Reporter:
                prappo Pavel Rappo
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: