![]() | Documentation Contents |
| Javadoc |
will use the standard doclet to produce the default-style HTML API documentation for myPackage. Running javadoc without the -doclet option is equivalent to running javadoc using the -doclet option to invoke the standard doclet. That is, the above command is equivalent to% javadoc myPackage
Both of these approaches are equivalent.% javadoc -docletpath /home/user/jdk1.5.0/lib/tools.jar \ -doclet com.sun.tools.doclets.standard.Standard \ myPackageor% javadoc -docletpath /home/user/jdk1.5.0/lib/tools.jar \ -doclet com.sun.tools.doclets.formats.html.HtmlDoclet \ myPackage
com.sun.tools.javadoc.Main in
lib/tools.jar. An example is given below.
The disadvantages of calling main are: (1) It can
only be called once per run -- for 1.2.x or 1.3.x, use
java.lang.Runtime.exec("javadoc ...") if more than one
call is needed, (2) it exits using System.exit(),
which exits the entire program, and (3) an exit code is not
returned.
public static void main(java.lang.String[] args)
The
- Command line interface.
- Parameters:
args- The command line parameters.
execute method overcomes all the disadvantages of
main.
public static int execute(java.lang.String[] args)
- Programmatic interface.
- Parameters:
args- The command line parameters.- Returns:
- The return code.
public static int execute(java.lang.String programName,
java.lang.String[] args)
- Programmatic interface.
- Parameters:
programName- Name of the program (for error messages).args- The command line parameters.- Returns:
- The return code.
public static int execute(java.lang.String programName,
java.lang.String defaultDocletClassName,
java.lang.String[] args)
- Programmatic interface.
- Parameters:
programName- Name of the program (for error messages).defaultDocletClassName- Fully qualified class name.args- The command line parameters.- Returns:
- The return code.
public static int execute(java.lang.String programName,
java.io.PrintWriter errWriter,
java.io.PrintWriter warnWriter,
java.io.PrintWriter noticeWriter,
java.lang.String defaultDocletClassName,
java.lang.String[] args)
- Programmatic interface.
- Parameters:
programName- Name of the program (for error messages).errWriter- PrintWriter to receive error messages.warnWriter- PrintWriter to receive error messages.noticeWriter- PrintWriter to receive error messages.defaultDocletClassName- Fully qualified class name.args- The command line parameters.- Returns:
- The return code.
Example
With classpath set to lib/tools.jar in the Java SE,
pass in each option and argument as a separate string:
com.sun.tools.javadoc.Main.execute(new String[] {"-d",
"docs", "-sourcepath", "/home/usr/src", "p1", "p2"});
src/share/classes/com/sun/tools/doclets.
Copyright © 1993, 2010, Oracle and/or its affiliates. All rights reserved. Please send comments using this Feedback page. |
Java Technology |