Mercurial > jdk8-mips64-public > langtools / annotate
test/tools/doclint/tool/HelpTest.out@ed1a48bedfa8 (annotated)
test/tools/doclint/tool/HelpTest.out
Wed, 24 Sep 2014 11:38:26 -0700
- author
- katleman
- date
- Wed, 24 Sep 2014 11:38:26 -0700
- changeset 2562
- ed1a48bedfa8
- parent 1885
- d6158f8d7235
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
Added tag jdk8u40-b07 for changeset 2fa3858a281f
| jjg@1506 | 1 | Usage: |
| jjg@1506 | 2 | doclint [options] source-files... |
| jjg@1506 | 3 | |
| jjg@1506 | 4 | Options: |
| jjg@1506 | 5 | -Xmsgs |
| jjg@1506 | 6 | Same as -Xmsgs:all |
| jjg@1506 | 7 | -Xmsgs:values |
| jjg@1506 | 8 | Specify categories of issues to be checked, where 'values' |
| jjg@1506 | 9 | is a comma-separated list of any of the following: |
| jjg@1506 | 10 | reference show places where comments contain incorrect |
| jjg@1506 | 11 | references to Java source code elements |
| jjg@1506 | 12 | syntax show basic syntax errors within comments |
| jjg@1506 | 13 | html show issues with HTML tags and attributes |
| jjg@1506 | 14 | accessibility show issues for accessibility |
| jjg@1506 | 15 | missing show issues with missing documentation |
| jjg@1506 | 16 | all all of the above |
| jjg@1506 | 17 | Precede a value with '-' to negate it |
| jjg@1506 | 18 | Categories may be qualified by one of: |
| jjg@1506 | 19 | /public /protected /package /private |
| jjg@1506 | 20 | For positive categories (not beginning with '-') |
| jjg@1506 | 21 | the qualifier applies to that access level and above. |
| jjg@1506 | 22 | For negative categories (beginning with '-') |
| jjg@1506 | 23 | the qualifier applies to that access level and below. |
| jjg@1506 | 24 | If a qualifier is missing, the category applies to |
| jjg@1506 | 25 | all access levels. |
| jjg@1506 | 26 | For example, -Xmsgs:all,-syntax/private |
| jjg@1506 | 27 | This will enable all messages, except syntax errors |
| jjg@1506 | 28 | in the doc comments of private methods. |
| jjg@1506 | 29 | If no -Xmsgs options are provided, the default is |
| jjg@1506 | 30 | equivalent to -Xmsgs:all/protected, meaning that |
| jjg@1506 | 31 | all messages are reported for protected and public |
| jjg@1506 | 32 | declarations only. |
| jjg@1506 | 33 | -stats |
| jjg@1506 | 34 | Report statistics on the reported issues. |
| jjg@1506 | 35 | -h -help --help -usage -? |
| jjg@1506 | 36 | Show this message. |
| jjg@1506 | 37 | |
| jjg@1506 | 38 | The following javac options are also supported |
| vromero@1885 | 39 | -bootclasspath, -classpath, -cp, -sourcepath, -Xmaxerrs, -Xmaxwarns |
| jjg@1506 | 40 | |
| jjg@1506 | 41 | To run doclint on part of a project, put the compiled classes for your |
| jjg@1506 | 42 | project on the classpath (or bootclasspath), then specify the source files |
| jjg@1506 | 43 | to be checked on the command line. |
