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

improve doclint support in javadoc

    Details

    • Type: Enhancement
    • Status: New
    • Priority: P4
    • Resolution: Unresolved
    • Affects Version/s: 15
    • Fix Version/s: None
    • Component/s: tools
    • Labels:
      None

      Description

      Currently, javadoc has a simpler set of doclint options, because it leverages the javadoc options to determine which elements should be documented.
      javac has no such concept, and so needs additional options to determine
      which elements to run through doclint.

      In javadoc, it might be nice to separate the concepts of which methods should be documented from those which should be checked with doclint. The primary use-case here is `missing` comments. It's still a weird case to be running javadoc on syntactically bad comments, etc.

      We should investigate the possibility of better aligning the javac and javadoc sets of doclint options.

      For reference, javac supports the following options:

        -Xdoclint:(all|none|[-]<group>)[/<access>]
              Enable or disable specific checks for problems in javadoc comments,
              where <group> is one of accessibility, html, missing, reference, or syntax,
              and <access> is one of public, protected, package, or private.
        -Xdoclint/package:[-]<packages>(,[-]<package>)*
              Enable or disable checks in specific packages. Each <package> is either the
              qualified name of a package or a package name prefix followed by .*, which
              expands to all sub-packages of the given package. Each <package> can be prefixed
              with - to disable checks for the specified package or packages.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                jjg Jonathan Gibbons
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated: