------
Configuring Javadoc Report
------
Vincent Siveton
------
01 March 2005
------
Javadoc Plugin Configuration
To generate the project javadocs as part of the site generation, add configuration
similar to the following to your POM:
-------------------
...
org.apache.maven.plugins
maven-javadoc-plugin
128m
512
...
...
...
------------------
To generate output from an alternate doclet in addition to the project javadocs, add configuration
similar to the following to your POM:
------------------
...
org.apache.maven.plugins
maven-javadoc-plugin
uml
gr.spinellis.umlgraph.doclet.UmlGraph
umlgraph
UMLGraph
4.2-SNAPSHOT
-views
target/uml
private
javadoc
html
private
javadoc
...
...
------------------
The configuration within is not used when javadoc is explicitly invoked
via 'mvn javadoc:javadoc'. To configure explicit invocation, use the element instead:
-------------------
...
org.apache.maven.plugins
maven-javadoc-plugin
128m
512
...
...
...
-------------------
Specific configuration for some Javadoc options
Some Javadoc options have a specific configuration. Add similar configuration to your POM:
*group
-------------------
...
org.apache.maven.plugins
maven-javadoc-plugin
...
Core Packages
org.apache.maven.plugin.javadoc.test1
Extension Packages
org.apache.maven.plugin.javadoc.test2
...
...
...
-------------------
*tag
-------------------
...
org.apache.maven.plugins
maven-javadoc-plugin
...
todo
a
To do something:
...
...
...
-------------------