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

Agree on javadoc terminology (once and for all)

    Details

    • Type: Task
    • Status: Open
    • Priority: P4
    • Resolution: Unresolved
    • Affects Version/s: 15
    • Fix Version/s: 16
    • Component/s: tools
    • Labels:

      Description

      The use of the terminology is messy. The word "javadoc" is used to refer to the command-line tool, comments in source files, documentation produced by that tool reading those comments, or individual pieces of that documentation.

      "javadoc" can be singular or plural and can be cased as "JavaDoc", "Javadoc", or "javadoc". Casing and pluralization work independently and produce monsters like "JavaDocs" or "Javadox".

      That applies not only to "javadoc", but to "tag", "taglet"; and to a lesser extent "doclet" and "doc comment".

      The javadoc vocabulary should be audited, the terminology should be agreed upon and then used consistently.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated: