ajdoc(1) [debian man page]
ajdoc(1) General Commands Manual ajdoc(1) NAME
ajdoc -- generate HTML API documentation, including crosscutting structure SYNOPSIS
ajdoc [ -bootclasspath classpathlist ] [ -classpath classpathlist ] [-d path] [-help] [-package] [-pro- tected] [-private] [-public] [-overview overviewFile] [ -sourcepath sourcepathlist ] [-verbose] [-version] [source- files... | packages... | @file... | -argfile file... ] [ ajc options ] Description ajdoc renders HTML documentation for AspectJ constructs as well as the Java constructs that javadoc renders. In addition ajdoc displays the crosscutting nature in the form of links. That means, for example, that you can see everything affecting a method when reading the doc- umentation for the method. To run ajdoc, use one of the scripts in the AspectJ bin directory. The ajdoc implementation builds on Sun's javadoc command line tool, and you use it in the same way with many of the same options (javadoc options are not documented here; for more information on javadoc usage, see the Javadoc homepage http://java.sun.com/j2se/javadoc/) . As with ajc (but unlike javadoc), you pass ajdoc all your aspect source files and any files containing types affected by the aspects; it's often easiest to just pass all the .java and .aj files in your system. Unlike ajc, ajdoc will try to find package sources using the speci- fied sourcepath if you list packages on the command line. To provide an argfile listing the source files, you can use use the same argfile (@filename) conventions as with ajc. For example, the following documents all the source files listed in argfile.lst, sending the output to the docDir output directory. ajdoc -d docDir @argfile.lst See the ajc documentation for details on the text file format. ajdoc honours ajc options. See the ajc documentation for details on these options. ajdoc currently requires the tools.jar from J2SE 1.3 to be on the classpath. Normally the scripts set this up, assuming that your JAVA_HOME 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. Examples Documenting Spacewar o Change into the examples directory. o Type mkdir doc destination directory for the documentation. o Type ajdoc -private -d doc spacewar coordination o (Use -private to get all members, since may of the interesting ones in spacewar are not public.) o Type ajdoc -private -d doc @spacewar/demo.lst to use the argfile associated with Spacewar. o To view the documentation, open the file index.html in the doc directory using a web browser. ajdoc(1)
Check Out this Related Man Page
javah(1) General Commands Manual javah(1) NAME
javah - C header and stub file generator SYNOPSIS
javah [ options ] fully-qualified-classname ... javah_g [ options ] fully-qualified-classname ... DESCRIPTION
The javah command generates C header and source files that are needed to implement native methods. The generated header and source files are used by C programs to reference instance variables of an object from native source code. The .h file contains a structure definition whose layout parallels that of the corresponding class. The fields in the structure correspond to instance variables in the class. The name of the header file and the structure declared within it are derived from the name of the class. If the class passed to javah is inside a package, the package name is prepended to both the header file name and the structure name. Underscores ( _ ) are used as name delimiters. By default, javah creates a header file for each class listed on the command line and puts the files in the current directory. Use the -stubs option to create source files. Use the -o option to concatenate the results for all listed classes into a single file. The new native method interface, Java Native Interface (JNI), does not require header information or stub files. The javah command can still be used to generate native method function prototypes needed for JNI-style native methods. javah produces JNI-style output by default, and places the result in the .h file. The javah_g version is a non-optimized version of javah suitable for use with debuggers like jdb. OPTIONS
The following options are supported: -o outputfile Concatenates the resulting header or source files for all the classes listed on the command line into outputfile. Only the -o or -d option may be used. -bootclasspath path Specifies path from which to load bootstrap classes. By default, the bootstrap classes are the classes implementing the core Java 2 platform located in jre/lib/rt.jar and several other jar files. -classpath path Specifies the path javah uses to look up classes. Overrides the default of the CLASSPATH environment variable if it is set. Directories are separated by colons. Thus the general format for path is: .:<your_path> For example: .:/home/avh/classes:/usr/local/java/classes -d directory Sets the directory where javah saves the header files or the stub files. -force Specifies that output files should always be written. -help Prints help message for javah usage. -jni Causes javah to create an output file containing JNI-style native method function prototypes. This is the default output, so use of -jni is optional. -old Specifies the old JDK1.0-style header files should be generated. -stubs Causes javah to generate C declarations from the Java object file. -trace Tracing is no longer supported. Instead, use the -verbose:jni option of the virtual machine. -verbose Indicates verbose output and causes javah to print a message to stdout concerning the status of the generated files. -version Print out javah version information. -Joption Pass option to the Java virtual machine, where option is one of the options described on the man page for the java applica- tion launcher, java(1). For example, -J-Xms48m sets the startup memory to 48 megabytes. It is a common convention for -J to pass options to the underlying virtual machine. ENVIRONMENT VARIABLES
CLASSPATH Used to provide the system with a path to user-defined classes. Directories are separated by colons, for example, .:/home/avh/classes:/usr/local/java/classes SEE ALSO
java(1), javac(1), javadoc(1), javap(1), jdb(1) 13 June 2000 javah(1)