table of contents
DOCTORJ(1) | DOCTORJ(1) |
NAME¶
doctorj - Javadoc analyzer and spell-checkerSYNOPSIS¶
doctorj [--emacs] [--warning=LEVEL] [--tabwidth=NUM] [ --dictionaries=LIST] [--verbose] {FILE...}
DESCRIPTION¶
doctorj is an application to analyze Javadoc comments against Java code, verifying its integrity and format. It also spell-checks Javadoc comments.OPTIONS¶
- --emacs
- Whether to list violations in Emacs form, i.e., a single
line of the form:
- --warning=LEVEL
- Sets the warning level, which by default is -1, meaning
that only errors are reported. A warning level of 0 means that Javadoc for
public or abstract items (classes, interfaces, methods, constructors, and
fields) will be checked. A warning level of 1 will result in the addition
of checking of protected-access items; 2 is for package-access items, and
3 will check all items.
- --tabwidth=NUM
- Sets the number of spaces to use for alignment with tabs.
By default, this value is 4.
- --dictionaries=LIST
- Sets the dictionaries (word lists) to use for
spell-checking. LIST is a comma-delimited string of paths to the
word list files. By default, doctorj uses the word list at
/usr/share/doctorj/words.LOCALE, where LOCALE is of the
standard Java form. doctorj is distributed with three word lists:
words.en_CA (Canadian English), words.en_UK (United Kingdom English), and
words.en_US (United States English).
- --verbose
- Produces debugging output. Note that this signficantly
impedes performance.
- FILE
- Specifies the files to check. If the argument specified is
a directory, all files ending in ``.java'' under that directory will be
analyzed.
EXAMPLES¶
To check a single file:-
% doctorj String.java
-
% doctorj String.java StringBuffer.java Object.java
-
% doctorj /proj/app/src
-
% doctorj --warning=4 .
-
% doctorj --dictionaries=/usr/share/dict/words .
CONFIGURATION¶
$HOME/.doctorjrc-
emacs: true warning: 4 tabwidth: 8 dictionaries: /usr/share/dict/words,/home/me/etc/terms verbose: false
-
adaxial cepaceous sabaton vespiaries
AUTHOR¶
Jeff Pace<jpace@incava.org>BUGS¶
Bugs and issues should be reported at the SourceForge.net project site: http://www.sf.net/projects/doctorjSEE ALSO¶
java(1), javadoc(1)