.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "DOCTORJ" 1 "" "" ""
.SH NAME
doctorj \- Javadoc analyzer and spell-checker
.SH "SYNOPSIS"

.nf
\fBdoctorj\fR [\fB--emacs\fR] [\fB--warning\fR\fI=LEVEL\fR] [\fB--tabwidth\fR\fI=NUM\fR]
        [\fB--dictionaries\fR\fI=LIST\fR] [\fB--verbose\fR] {\fIFILE...\fR}
.fi

.SH "DESCRIPTION"

.PP
doctorj is an application to analyze Javadoc comments against Java code, verifying its integrity and format. It also spell-checks Javadoc comments.

.SH "OPTIONS"

.TP
\fB--emacs\fR
Whether to list violations in Emacs form, i.e., a single line of the form:

8:48:9:4: An error occurred on this line.

By default, violations are displayed in ``long form'', showing the context.

.TP
\fB--warning\fR\fI=LEVEL\fR
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.

.TP
\fB--tabwidth\fR\fI=NUM\fR
Sets the number of spaces to use for alignment with tabs. By default, this value is 4.

.TP
\fB--dictionaries\fR\fI=LIST\fR
Sets the dictionaries (word lists) to use for spell-checking. \fILIST\fR is a comma-delimited string of paths to the word list files. By default, doctorj uses the word list at \fI/usr/share/doctorj/words.LOCALE\fR, where \fILOCALE\fR 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).

.TP
\fB--verbose\fR
Produces debugging output. Note that this signficantly impedes performance.

.TP
\fBFILE\fR
Specifies the files to check. If the argument specified is a directory, all files ending in ``.java'' under that directory will be analyzed.

.SH "EXAMPLES"

.PP
To check a single file: 

.IP
.nf
% doctorj String.java
.fi


.PP
To check multiple files: 

.IP
.nf
% doctorj String.java StringBuffer.java Object.java
.fi


.PP
To check all files below a directory: 

.IP
.nf
% doctorj /proj/app/src
.fi


.PP
To run at the maximum warning level: 

.IP
.nf
% doctorj --warning=4 .
.fi


.PP
To specify a different dictionary: 

.IP
.nf
% doctorj --dictionaries=/usr/share/dict/words .
.fi


.SH "CONFIGURATION"

.PP
\fB$HOME/.doctorjrc\fR

.PP
The run-control file, of the form: 

.IP
.nf

emacs: true
warning: 4
tabwidth: 8
dictionaries: /usr/share/dict/words,/home/me/etc/terms
verbose: false
         
.fi
 

.PP
Dictionary (word list) files contain one word per line, for example:

.PP
 

.IP
.nf

adaxial
cepaceous
sabaton
vespiaries
        
.fi
 

.SH "AUTHOR"

.PP
Jeff Pace<jpace@incava.org>

.PP
The DoctorJ web site is at \fIhttp://www.doctorj.org\fR.

.SH "BUGS"

.PP
Bugs and issues should be reported at the SourceForge.net project site: \fIhttp://www.sf.net/projects/doctorj\fR 

.SH "SEE ALSO"

.PP
 \fBjava\fR(1), \fBjavadoc\fR(1) 

.SH "COPYRIGHT"

.PP
Copyright (c) 2002, Jeff Pace.

.PP
All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the terms of the GNU Lesser General Public License: \fIhttp://www.gnu.org/licenses/lgpl.html\fR