Download/InstallationRequirements
XDoclet will run on any platform where there is a suitable
Java 2 runtime environment
.
You have to make sure
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. Downloading XDocletThe latest stable version of XDoclet is available from the SourceForge download page . The available distribution archives are:
Make sure you also download xjavadoc-1.0 (and put the jar in the classpath too), as it is required by XDoclet. Installing XDocletDepending on the XDoclet distribution archive you downloaded, it consists of the following directory layout:
Getting XDoclet from CVSIf 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. Getting XDoclet from CVS from Behind a FirewallIf 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 . If you need to checkout or update from behind a firewall, you can use CVSGrab (reads the repository via the XDoclet ViewCVS web interface ). Building XDoclet from SourcesFollow these steps carefully:
To change the compiler, modify the
Please note that the
Generating the XDoclet DocumentationXDoclet uses Maven and XDoclet (yes, we do eat our own dog food!) to generate the documentation. The documentation consists out of the following parts:
Anakia
format. More information along
with samples, can be found at:
To generate the documentation, follow these steps carefully:
|