public class PtDoclet
extends java.lang.Object
If javadoc is called with -d directoryName, then
documentation will be generated in directoryName.
If the KEPLER property is set, then for a class named
foo.bar.Baz
, the generated file is named
Baz.doc.xml
. If the KEPLER property is not
set, then the generated file is named foo/bar/Baz.xml
.
This doclet writes the names of all the classes for which documentation was generated in a file called allNamedObjs.txt
Constructor and Description |
---|
PtDoclet() |
Modifier and Type | Method and Description |
---|---|
static int |
optionLength(java.lang.String option)
Given a command line option, return the number of command line
arguments needed by that option.
|
static boolean |
start(com.sun.javadoc.RootDoc root)
Process the java files and generate PtDoc XML.
|
public static int optionLength(java.lang.String option)
option
- The command line optionpublic static boolean start(com.sun.javadoc.RootDoc root) throws java.io.IOException, java.lang.ClassNotFoundException
root
- The root of the java doc tree.java.io.IOException
- If there is a problem writing the documentation.java.lang.ClassNotFoundException
- If there is a problem finding
the class of one of the fields.