prcs-javadoc8

Usage

Overview

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 ENVIRONMENT section.

Environment

PRCS_REPOSITORY

see prcs (1)

JAVA

Path to the java executable, the default is whatever "java" is found in PATH, or if that fails /usr/local/java/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 nothing.

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.