The idea behind this plugin is to generate javadoc-like documentation for Jelly tags. Now there are various projects which define their own library (or libraries) of Jelly tags. So this code which used to reside inside the Jelly build has now been refactored into a Maven plugin.
To add it to your build just add this to your maven.xml
<preGoal name="site">
<attainGoal name="jellydoc"/>
</preGoal>
Its still fairly simple and basic right now. Its using a doclet (rather than xdoclet or qdox) and doesn't handle DynaTag implementations very well - so I'm sure we can improve this over time. However for now this might help other projects (like Maven itself as well as other projects like Latka, Drools, Werkflow etc) create auto-generated documentation for their tags.
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@112852 13f79535-47bb-0310-9956-ffa450edef68
28 lines
675 B
XML
28 lines
675 B
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<document>
|
|
|
|
<properties>
|
|
<title>JellyDoc Plugin Goals</title>
|
|
<author email="jstrachan@apache.org">James Strachan</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Goals">
|
|
<table>
|
|
<tr><th>Goal</th><th>Description</th></tr>
|
|
|
|
<a name="jellydoc" />
|
|
<tr>
|
|
<td>jellydoc</td>
|
|
<td>
|
|
The default goal. This goal generates the JellyDoc documentation of
|
|
all Jelly tags defined within your code base which can then be styled
|
|
into HTML as part of the xdoc goal
|
|
</td>
|
|
</tr>
|
|
|
|
</table>
|
|
</section>
|
|
</body>
|
|
</document>
|