--- name: "prcs-javadoc" section: "8" platform: "linux" package: "prcs-utils" version: "1.3.3-8" release: "Debian 4.0 (Etch)" platforms: ["linux"] url: "https://new.carta.tech/prcs-javadoc" --- # prcs-javadoc(8) creates javadoc documentation for PRCS projects ## 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 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. ## BUGS Does not seem to correctly generate the index. Doesn't take command line options. ## SEE ALSO [**prcs**(1)](/prcs/1.md), **javadoc, java** ## AUTHOR This manual page was written by Rafael Kitover \.