javac tool documentation: Xdoclint

[Pardeep Sharma]

Team,

 

Need help with confirming few options with Xdoclint as part of the improvement in javac documentation and help.

Is there a way to confirm the default access level for -Xdoclint in javac for JDk 8 and 9?

 

When we run javac -X (9ea), get this:

---------------------------

$ javac -X

    -Xdoclint                  Enable recommended checks for problems in javadoc coments

  -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 synta,

        and <access> is one of public, protected, package, or private.

  -Xdoclint/package:([-]<packages>)

        Enable or disable checks in specific packages. <packages> is a comma sepaated

        list of package specifiers. Package specifier is either a qualified name f a package

        or a package name prefix followed by .*, which expands to all sub-package of

        the given package. Prefix the package specifier with - to disable checks or

        the specified packages.

Note: Apart from corrections in few spellings (coments, separated, f) in the above output, it may be nice to know,

- What are the 'recommended' checks?

- Even though the variable access seems optional, it may help if such options are made clear in the help output or in the documentation.

 

This has come as a suggestion in HYPERLINK "https://bugs.openjdk.java.net/browse/JDK-8073216"JDK-8073216 .

" in the description of "-Xdoclint:[-]group [/access]", the default access level must be specified (for Java 1.8.0_31, the default is private)"

Existing doc url: 

http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javac.html 

 

Thank You,

Pardeep

 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.openjdk.java.net/pipermail/compiler-dev/attachments/20160802/137074c5/attachment-0001.html>