org.znerd.javadoxml
Class JavadoXML

java.lang.Object
  |
  +--com.sun.javadoc.Doclet
        |
        +--org.znerd.javadoxml.JavadoXML

public final class JavadoXML
extends com.sun.javadoc.Doclet

Doclet that generates XML output.

This doclet recognizes the following options:

-out
The output file to write to. The default is apidocs.xml.
-indent
The indentation to use, if any. The default is no indentation..
-newlines
Flag that indicates if newlines should be used. Valid values are true or yes if newlines should be used, and false or no if no newlines should be used. The default is no.
-encoding
The encoding to use. The default is UTF-8.

Version:
$Revision: 1.21 $ $Date: 2003/04/26 15:20:55 $
Author:
Ernst de Haan (znerd@FreeBSD.org)

Method Summary
static int optionLength(String option)
          Checks a doclet option.
 boolean run(com.sun.javadoc.RootDoc root)
          Runs this doclet.
static boolean start(com.sun.javadoc.RootDoc root)
          Generates the XML API documentation.
 
Methods inherited from class com.sun.javadoc.Doclet
validOptions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

optionLength

public static int optionLength(String option)
                        throws IllegalArgumentException
Checks a doclet option.
Parameters:
option - the doclet option to check, not null.
Returns:
the number of arguments the option has, or 0 (zero) if the argument is unknown, or a negative value in case of an error.
Throws:
IllegalArgumentException - if option == null.

start

public static boolean start(com.sun.javadoc.RootDoc root)
                     throws IllegalArgumentException
Generates the XML API documentation.
Parameters:
root - the packages and/or classes to document, not null.
Returns:
true on success, false otherwise.
Throws:
IllegalArgumentException - if root == null.

run

public boolean run(com.sun.javadoc.RootDoc root)
            throws IllegalArgumentException,
                   IllegalStateException
Runs this doclet.
Parameters:
root - the packages and/or classes to document, not null.
Returns:
true on success, false otherwise.
Throws:
IllegalArgumentException - if root == null.
IllegalStateException - if this doclet is currently already running.


Copyright Ernst de Haan
See http://javadoxml.sourceforge.net/.