Java API Reference Specialization

Purpose: The Java API Reference specialization provides a basis for documenting Java class libraries. The specialization can be used or examined as an example of how to extend the base API Reference specialization.

Prerequisite: API Reference specialization.

You can view the reference documentation for the Java API Reference specialization.

Building

The Java API Reference specialization provides the conductor.xml file to extend the base Ant targets with the following build targets:

javaref2xhtml
Build the Java API map for a sample Java package to XHTML.

The run-ant.xml file executes this build targets on the sample content.

You should run the sample Ant build from the base directory for the DITA Open Toolkit, using a relative path to the Java API Reference specialization:

ant -f demo\javaapiref\install_plugin.xml
ant -f demo\javaapiref\run_ant.xml optionalTarget

You need only execute the install_plugin.xml file after initial installation or update of any plugin.

Contents

The specialization includes subdirectories with the following contents:

doc
The source files and output for the documentation.
dtd
DTDs for the document type for the API Reference specialization.
out
Formatted sample output files from the Ant build.
sample
Source files for an example of package content.
xsd
XML Schemas for the document type for the API Reference specialization.
xsl
Transforms for producing the output of the Ant build.

Contributors

Erik Hennum, Dennis Grace, Mariana Alupului, Michael Priestley, Michelle C Carey, Nigel Hopper, Rob Pierce, and Robert D Anderson