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