XDoclet will run on any platform where there is a suitable
Java 2 runtime environment.
You have to make sure
tools.jar from JDK's
lib directory is on
your classpath, and that you are using Jakarta Ant
1.5 or higher (XDoclet does not support previous versions).
XDoclet has been used successfully on many platforms, including Linux, UNIX, Windows 9x, NT, 2000 and XP, MacOSX.
Starting from XDoclet 2, JDK 1.4 is required to run (and build) XDoclet. However, the generated sources are still compilable on JDK 1.3 environments.
The latest stable version of XDoclet is available from the SourceForge download page.
The available distribution archives are:
Depending on the XDoclet distribution archive you downloaded, it consists of the following directory layout:
index.htmlin this directory
antin this directory)
The Xdoclet web site has a repository set up, at http://xdoclet.sourceforge.net/repository.
The individual jars and the maven plugin can be found at this location.
Maven users can add the above location to their
If you need access to the latest source code, and like living on the bleeding edge (don't complain we didn't warn you), you need understanding of CVS and a CVS client.
Follow the instructions explained here to configure your client.
If you are behind a firewall, or you do not want to install a CVS client, a daily CVS dump is available at http://xdoclet.sourceforge.net/xdoclet-cvs.zip.
Follow these steps carefully:
ant(optionally append the target)
core- build the core
modules- build the core and the modules
docs- build the core, modules and generate the documentation
samples- build the core, modules and samples
dist- build everything and package it into archives (this is the default target)
clean- revert back to the source distribution
patch- makes one patch file containing all local changes
To change the compiler, modify the
build.properties file, and change the
property to your preferred value. To build using
Jikes, change the
modern value to
jikes and make sure Jikes is on your path.
Please note that the
MISSING RESOURCE errors displayed when building the xdoclet module are NOT bugs.
XDoclet uses Maven and XDoclet (yes, we do eat our own dog food!) to generate the documentation.
The documentation consists out of the following parts:
ant-docstarget, using AntdocSubTask)
docstarget, using xslt (xdocs/stylesheets/xtags2xdoc.xslt) to convert
documenttarget, using DocumentDocletTask)
todotarget, using DocumentDocletTask)
Anakiaformat. More information along with samples, can be found at:
ant(this builds XDoclet and the documentation)
ant -f build-docs.xml(this will only build the documentation, but you need to build XDoclet first)