jjg@1506: Usage: jjg@1506: doclint [options] source-files... jjg@1506: jjg@1506: Options: jjg@1506: -Xmsgs jjg@1506: Same as -Xmsgs:all jjg@1506: -Xmsgs:values jjg@1506: Specify categories of issues to be checked, where 'values' jjg@1506: is a comma-separated list of any of the following: jjg@1506: reference show places where comments contain incorrect jjg@1506: references to Java source code elements jjg@1506: syntax show basic syntax errors within comments jjg@1506: html show issues with HTML tags and attributes jjg@1506: accessibility show issues for accessibility jjg@1506: missing show issues with missing documentation jjg@1506: all all of the above jjg@1506: Precede a value with '-' to negate it jjg@1506: Categories may be qualified by one of: jjg@1506: /public /protected /package /private jjg@1506: For positive categories (not beginning with '-') jjg@1506: the qualifier applies to that access level and above. jjg@1506: For negative categories (beginning with '-') jjg@1506: the qualifier applies to that access level and below. jjg@1506: If a qualifier is missing, the category applies to jjg@1506: all access levels. jjg@1506: For example, -Xmsgs:all,-syntax/private jjg@1506: This will enable all messages, except syntax errors jjg@1506: in the doc comments of private methods. jjg@1506: If no -Xmsgs options are provided, the default is jjg@1506: equivalent to -Xmsgs:all/protected, meaning that jjg@1506: all messages are reported for protected and public jjg@1506: declarations only. jjg@1506: -stats jjg@1506: Report statistics on the reported issues. jjg@1506: -h -help --help -usage -? jjg@1506: Show this message. jjg@1506: jjg@1506: The following javac options are also supported vromero@1885: -bootclasspath, -classpath, -cp, -sourcepath, -Xmaxerrs, -Xmaxwarns jjg@1506: jjg@1506: To run doclint on part of a project, put the compiled classes for your jjg@1506: project on the classpath (or bootclasspath), then specify the source files jjg@1506: to be checked on the command line.