1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/test/tools/doclint/tool/HelpTest.out Mon Jan 21 10:00:46 2013 -0800
1.3 @@ -0,0 +1,43 @@
1.4 +Usage:
1.5 + doclint [options] source-files...
1.6 +
1.7 +Options:
1.8 + -Xmsgs
1.9 + Same as -Xmsgs:all
1.10 + -Xmsgs:values
1.11 + Specify categories of issues to be checked, where 'values'
1.12 + is a comma-separated list of any of the following:
1.13 + reference show places where comments contain incorrect
1.14 + references to Java source code elements
1.15 + syntax show basic syntax errors within comments
1.16 + html show issues with HTML tags and attributes
1.17 + accessibility show issues for accessibility
1.18 + missing show issues with missing documentation
1.19 + all all of the above
1.20 + Precede a value with '-' to negate it
1.21 + Categories may be qualified by one of:
1.22 + /public /protected /package /private
1.23 + For positive categories (not beginning with '-')
1.24 + the qualifier applies to that access level and above.
1.25 + For negative categories (beginning with '-')
1.26 + the qualifier applies to that access level and below.
1.27 + If a qualifier is missing, the category applies to
1.28 + all access levels.
1.29 + For example, -Xmsgs:all,-syntax/private
1.30 + This will enable all messages, except syntax errors
1.31 + in the doc comments of private methods.
1.32 + If no -Xmsgs options are provided, the default is
1.33 + equivalent to -Xmsgs:all/protected, meaning that
1.34 + all messages are reported for protected and public
1.35 + declarations only.
1.36 + -stats
1.37 + Report statistics on the reported issues.
1.38 + -h -help --help -usage -?
1.39 + Show this message.
1.40 +
1.41 +The following javac options are also supported
1.42 + -bootclasspath, -classpath, -sourcepath, -Xmaxerrs, -Xmaxwarns
1.43 +
1.44 +To run doclint on part of a project, put the compiled classes for your
1.45 +project on the classpath (or bootclasspath), then specify the source files
1.46 +to be checked on the command line.
