Apache Maven 1.x has reached its end of life, and is no longer supported. For more information, see the announcement. Users are encouraged to migrate to the current version of Apache Maven.

Maven 1.x XDoc Plug-in

Overview

The Xdoc plugin is the primary mechanism used to produce the Maven-generated documentation as well as any user supplied "xdocs". An xdoc is an XML document conforming to a small and simple set of tags. Maven uses this format extensively. All Maven-generated reports are first generated as an xdoc, which is then transformed to HTML via this plugin.

The documentation is mainly in Anakia format. More information along with samples, can be found at:

There are a few additions to the Anakia format, they are highlighted in the reference documents.

Additional Files

In addition to xdocs, users may wish to include other types of files such as images, their own HTML files, PDFs, etc. By default, this plugin will copy all files located in the maven.docs.src directory (xdocs by default) to the final generated site.

If you create a style/project.css stylesheet under maven.docs.src, it will be copied to the resulting document tree and imported into each page (via @import). This allows you to easily add and modify the styles that are provided by Maven.