User Documentation

One Minute Introduction

Two Minute Introduction

Your own plugin

Coffee Break Introduction

Property substitution

FAQ

IDE Integration

Doclipse

Maven Integration

Maven2 Plugin

Maven1 Plugin

Plugins

• Actionscript plugin
• Beaninfo plugin
• Castor plugin
• Ejb plugin
• Externalizer plugin
• Hibernate plugin
• Interfaceextractor plugin
• Jdo plugin
• Jmx plugin
• Junit plugin
• Plugin plugin
• Portlet plugin
• Qtags plugin
• Spring plugin
• Struts plugin
• Tapestry plugin
• Web plugin
• Webwork plugin
• Xtags plugin
• Xwork plugin

Project Information

Mailing lists

Source Repositories

Open Issues

Team

Developer Documentation

Feeds

• Site
• News

Foreword

To use this plugin, you will need maven 2.0.1 or a more recent version. It will not work with 2.0.0, due to a bug in the plugin dependencies classloading. (See MNG-1804@jira)

This is based on Espen Amble Kolstad's contribution from XDOCLET-38@jira, so kudos to him.

It seems to me this plugin could be the nicest way to use xdoclet2, because you will not need to have 3 gazillion dependencies in your projects anymore. The only dependencies you'll have to specify will the the xdoclet-plugins you want to use - and they will not be in your project main dependencies, but in build/plugins/dependencies, so they're really isolated from your actual project.

Reading this document shouldn't prevent you from learning the basic maven usage. Read maven docs at http://maven.apache.org

Reading this document shouldn't prevent you from getting basic XDoclet2 knowledge.

Installation

If you only want to try and install the xdoclet2-maven2 plugin on your local machine, you can build and install it from source by running

or download the plugin jar from here and run the following:

where <path-to-file> is the path to the plugin jar you just downloaded.

... But it's probably better to:

Stay up-to-date

If you want to stay up-to-date while this plugin is being worked on, you should add this to your pom's project/pluginRepositories element:

Usage

To use the plugin, add the following to your pom: (of course, skip the <build> tag if you already have a build section)

Of course this is a sample. Please get to know XDoclet2 and how it generally works before complaining that this doesn't work. (this is real snippet used to build

xdoclet2 plugins). For real life usage you need to consult documentaton on plugins you

like to use

Note 1: all of this could potentially go to a parent pom's <pluginManagement> element. However, it seems MNG-1804@jira has not fixed this case, so you currently still need to specify the plugin dependencies in the child pom. See MNG-1703@jira