|AurigaDoclet: User Guide|
AurigaDoclet is a Javadoc doclet which can generate Java API document in fo, pdf, postscript, pcl, and svg format. AurigaDoclet accepts command line options which can be used to further customize the generated output.
AurigaDoclet generates javadoc as an XML tree which is then transformed into FO. This FO stream is then serialized using Apache FOP to generate pdf, postscript, pcl and svg output.
Command Line: AurigaDoclet can be invoked from
javadoc command line program by using the
-doclet parameter like this.
javadoc -doclet com.aurigalogic.doclet.core.Doclet -docletpath docletpath ...
Apache ANT: AurigaDoclet can used from ANT using the
javadoc task like this.
<javadoc packagenames="package-names" sourcepath="source-path" doclet="com.aurigalogic.doclet.core.Doclet" docletpath="aurigadoclet-path" additionalparam="options" > <classpath refid="aurigadoclet.class.path" /> </javadoc>
AurigaDoclet will try to cleanup the XHTML content in the header, footer, cover and also the javadoc comments to make it XML compliant. But if the content could not be cleaned up, it will use the original contant which may cause XML parser errors.
This error is usually encountered with JDK 1.4 or above. This error is caused by xalan library shipped with the JDK. In order to resolve this copy the xerces and xalan jars from AurigaDoclet's lib directory to your jre's endorsed folder. The exact path of the endorsed folder can be determined by the system propertyCannot find doclet class com.aurigalogic.doclet.core.Doclet
Make sure you have specified the correct path to AurigaDoclet.jar in the -docletpath argument. Also make sure that the AurigaDoclet.jar is located in AurigaDoclet's bin directory. This is so that AurigaDoclet.jar can find the additional jars which are located in AurigaDoclet's lib directory.