.TH "ajdoc" "1" 
.SH "NAME" 
ajdoc \(em generate HTML API documentation, including crosscutting structure 
 
.SH "SYNOPSIS" 
.PP 
\fBajdoc\fR [        \-bootclasspath \fIclasspathlist\fR       ]  [        \-classpath \fIclasspathlist\fR       ]  [\-d \fIpath\fR]  [\-help]  [\-package]  [\-protected]  [\-private]  [\-public]  [\-overview \fIoverviewFile\fR]  [        \-sourcepath \fIsourcepathlist\fR       ]  [\-verbose]  [\-version]  [\fIsourcefiles...\fR  | \fIpackages...\fR  | @\fIfile...\fR  | \-argfile \fIfile...\fR ]  [        \fIajc options\fR       ]  
.SH "Description" 
.PP 
\fBajdoc\fR renders HTML documentation for AspectJ  
constructs as well as the Java constructs that  
\fBjavadoc\fR renders. 
In addition \fBajdoc\fR displays the crosscutting 
nature in the form of links. That means, for example, that  
you can see everything affecting a method when reading  
the documentation for the method. 
 
.PP 
To run \fBajdoc\fR, use one of the scripts in the  
AspectJ \fBbin\fP directory.  
The \fBajdoc\fR implementation builds on Sun's \fBjavadoc\fR  
command line tool, and you use it in the same way with many of 
the same options 
(\fBjavadoc\fR options are not documented here; 
for more information on \fBjavadoc\fR usage, see the 
\fIJavadoc homepage http://java.sun.com/j2se/javadoc/) \fR.
 
.PP 
As with \fBajc\fR (but unlike \fBjavadoc\fR), 
you pass \fBajdoc\fR all your aspect source files  
and any files containing types affected by the aspects; 
it's often easiest to just pass all the \fB.java\fP  
and \fB.aj\fP files in your system. 
Unlike \fBajc\fR, 
\fBajdoc\fR will try to find package sources using the 
specified sourcepath if you list packages on the command line.  
 
.PP 
To provide an argfile listing the source files, you can use 
use the same argfile (\fB@filename\fP) conventions  
as with \fBajc\fR.   
For example, the following documents all the source files listed 
in \fBargfile.lst\fP, sending the output to 
the \fBdocDir\fP output directory. 
 
 
.PP 
.nf 
ajdoc \-d docDir @argfile.lst 
.fi 
.PP 
 
See the \fIajc documentation\fR  
for details on the text file format. 
 
.PP 
\fBajdoc\fR honours \fBajc\fR options. See 
the \fIajc documentation\fR for details on 
these options. 
 
.PP 
\fBajdoc\fR currently requires the  
\fBtools.jar\fP from J2SE 1.3 to be on the classpath. 
Normally the scripts set this up, assuming that your \fBJAVA_HOME\fP       variable points to an appropriate installation of Java. 
You may need to provide this jar when using a different 
version of Java or a JRE. 
 
.SH "Examples" 
.PP 
\fBDocumenting Spacewar\fR 
.IP "   \(bu" 6 
Change into the \fBexamples\fP directory. 
 
.IP "   \(bu" 6 
Type  
.ft B 
mkdir doc 
.ft to create the 
destination directory for the documentation. 
 
.IP "   \(bu" 6 
Type  
.ft B 
ajdoc \-private \-d doc spacewar 
coordination 
.ft to generate the documentation. 
 
.RS 
.IP "   \(bu" 6 
(Use \fB-private\fP to get all members, since 
may of the interesting ones in spacewar are not public.) 
 
.RE 
.IP "   \(bu" 6 
Type  
.ft B 
ajdoc \-private \-d doc @spacewar/demo.lst 
.ft  
to use the argfile associated with Spacewar.   
 
.IP "   \(bu" 6 
To view the documentation, open the file \fBindex.html\fP  
in the \fBdoc\fP directory using a web browser. 
 
.\" created by instant / docbook-to-man