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

[spec] Clean up terminology regarding doc comment descriptions.

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P4 P4
    • 19
    • None
    • tools
    • None

      javadoc and doclint are inconsistent in their use of the term "description", as regards to parts of a documentation comment. This can be confusing. We should define such terms and use them consistently.

      It would help to reorganize the "General Syntax" section of the Doc Comment Spec, to better define the parts of a doc comment, including the introduction of a paragraph defining "Main Description".

            jjg Jonathan Gibbons
            jjg Jonathan Gibbons
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: