prcs-javadoc(8)

NAME

prcs-javadoc - creates javadoc documentation for PRCS

projects

SYNOPSIS

prcs-javadoc list-of-projects destination-directory

DESCRIPTION

prcs-javadoc is a bourne shell script that goes through a

list of PRCS projects and runs javadoc through them. Projects do

not have to be purely java projects, as long as they have .java

files and use packages. It is especially convenient for nightly

builds.

OPTIONS

This program takes no options at this time, see the ENVI

RONMENT section.

ENVIRONMENT

PRCS_REPOSITORY

see prcs (1)

JAVA Path to the java executable, the default is whatev

er "java" is found in PATH, or if that fails /usr/local/ja

va/bin/java.

JAVA_ARGS

Arguments to run java with, default is "-mx64m

-ms64m" to give java a starting and max heap size of 64 megs,

this stuff eats ALOT of RAM.

JAVA_COMPILER

JIT compiler to use, defaults to "tya" for 1.1 JDKs

and "sunwjit" for 1.2 JDKs if it is not set, otherwise does noth

ing.

JAVADOC

Class to run for javadoc, defaults to

"sun.tools.javadoc.Main".

JAVADOC_ARGS

Parameters for javadoc, default is "-private" to

generate all methods and variables. See "javadoc".

JAVADOC_IMAGES

Directory where images used by the results of

javadoc maybe found. The default is the first directory that has

the file "method-index.gif" in it.

EXAMPLES

prcs-javadoc foo bar baz /var/www/doc-build

Builds the documentation for files in projects foo, bar

and baz and places it into the directory /var/www/doc-build.

BUGS

Does not seem to correctly generate the index. Doesn't

take command line options.

SEE ALSO

prcs(1), javadoc, java

AUTHOR

This manual page was written by Rafael Kitover <caelum@de

bian.org>.

prcs-javadoc 11/5/1999

PRCS-JAVADOC(8)