langtools/test/tools/doclint/tool/HelpTest.out
author jlahoda
Wed, 11 Mar 2015 22:24:05 +0100
changeset 29427 44f4e6905b67
parent 18898 0eab5f5e3d1d
permissions -rw-r--r--
8071851: Provide filtering of doclint checking based on packages Summary: Introducing -Xdoclint/package:<packages> doclint option to enable/disable checking of specified packages. Reviewed-by: jjg, darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
15370
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
     1
Usage:
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
     2
    doclint [options] source-files...
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
     3
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
     4
Options:
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
     5
  -Xmsgs  
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
     6
    Same as -Xmsgs:all
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
     7
  -Xmsgs:values
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
     8
    Specify categories of issues to be checked, where 'values'
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
     9
    is a comma-separated list of any of the following:
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    10
      reference      show places where comments contain incorrect
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    11
                     references to Java source code elements
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    12
      syntax         show basic syntax errors within comments
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    13
      html           show issues with HTML tags and attributes
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    14
      accessibility  show issues for accessibility
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    15
      missing        show issues with missing documentation
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    16
      all            all of the above
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    17
    Precede a value with '-' to negate it
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    18
    Categories may be qualified by one of:
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    19
      /public /protected /package /private
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    20
    For positive categories (not beginning with '-')
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    21
    the qualifier applies to that access level and above.
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    22
    For negative categories (beginning with '-')
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    23
    the qualifier applies to that access level and below.
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    24
    If a qualifier is missing, the category applies to
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    25
    all access levels.
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    26
    For example, -Xmsgs:all,-syntax/private
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    27
    This will enable all messages, except syntax errors
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    28
    in the doc comments of private methods.
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    29
    If no -Xmsgs options are provided, the default is
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    30
    equivalent to -Xmsgs:all/protected, meaning that
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    31
    all messages are reported for protected and public
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    32
    declarations only. 
29427
44f4e6905b67 8071851: Provide filtering of doclint checking based on packages
jlahoda
parents: 18898
diff changeset
    33
  -XcheckPackage:<packages>
44f4e6905b67 8071851: Provide filtering of doclint checking based on packages
jlahoda
parents: 18898
diff changeset
    34
    Enable or disable checks in specific packages.
44f4e6905b67 8071851: Provide filtering of doclint checking based on packages
jlahoda
parents: 18898
diff changeset
    35
    <packages> is a comma separated list of package specifiers.
44f4e6905b67 8071851: Provide filtering of doclint checking based on packages
jlahoda
parents: 18898
diff changeset
    36
    Package specifier is either a qualified name of a package
44f4e6905b67 8071851: Provide filtering of doclint checking based on packages
jlahoda
parents: 18898
diff changeset
    37
    or a package name prefix followed by '.*', which expands to
44f4e6905b67 8071851: Provide filtering of doclint checking based on packages
jlahoda
parents: 18898
diff changeset
    38
    all sub-packages of the given package. Prefix the package specifier
44f4e6905b67 8071851: Provide filtering of doclint checking based on packages
jlahoda
parents: 18898
diff changeset
    39
    with '-' to disable checks for the specified packages.
15370
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    40
  -stats
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    41
    Report statistics on the reported issues.
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    42
  -h -help --help -usage -?
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    43
    Show this message.
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    44
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    45
The following javac options are also supported
18898
0eab5f5e3d1d 8009924: some langtools tools do not accept -cp as an alias for -classpath
vromero
parents: 15370
diff changeset
    46
  -bootclasspath, -classpath, -cp, -sourcepath, -Xmaxerrs, -Xmaxwarns
15370
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    47
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    48
To run doclint on part of a project, put the compiled classes for your
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    49
project on the classpath (or bootclasspath), then specify the source files
c1c9a9e11b26 8006263: Supplementary test cases needed for doclint
jjg
parents:
diff changeset
    50
to be checked on the command line.