dion 2002/10/03 02:50:55
Added: src/plugins-build/antlr/xdocs goals.xml navigation.xml
properties.xml changes.xml
Log:
Added documentation on the plugin
Revision Changes Path
1.1 jakarta-turbine-maven/src/plugins-build/antlr/xdocs/goals.xml
Index: goals.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Maven Ant Plug-in Goals</title>
<author email="[EMAIL PROTECTED]">dIon Gillard</author>
</properties>
<body>
<section name="Goals">
<p>
<strong>Note:</strong> The goals in this plugin are only executed
when the <a href="properties.html">maven.antlr.src.dir</a> property
is set
</p>
<table>
<tr><th>Goal</th><th>Description</th></tr>
<tr>
<td>antlr:generate</td>
<td>
<p>
Generates code for all grammars defined in the
<a href="properties.html">${maven.antlr.grammars}</a>
property.
</p>
<p>
This goal is called before the <code>java:compile</code>
goal so that code is generated before compilation.
</p>
</td>
</tr>
<tr>
<td>antlr:prepare-filesystem</td>
<td>
<p>
Creates the <code>${maven.build.dir}/antlr</code>
directory which holds antlr generated code.
</p>
<p>
This directory is added to the code to be compiled by
Maven, as specified by the <code>maven.compile.src.set</code>
property.
</p>
</td>
</tr>
</table>
</section>
</body>
</document>
1.1
jakarta-turbine-maven/src/plugins-build/antlr/xdocs/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Maven Activity Plugin">
<title>Maven Antlr Plugin</title>
<body>
<links>
<item name="Maven" href="http://jakarta.apache.org/turbine/maven/"/>
<item name="Antlr" href="http://www.antlr.org/"/>
</links>
<menu name="Overview">
<item name="Goals" href="/goals.html" />
<item name="Properties" href="/properties.html" />
</menu>
</body>
</project>
1.1
jakarta-turbine-maven/src/plugins-build/antlr/xdocs/properties.xml
Index: properties.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<title>Maven Antlr Plugin Properties</title>
<author email="[EMAIL PROTECTED]">dIon Gillard</author>
</properties>
<body>
<section name="Maven Antlr Plugin Settings">
<table>
<tr>
<th>Property name</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>maven.antlr.grammars</td>
<td>No</td>
<td>
Sets the grammars to generate code for.
</td>
</tr>
<tr>
<td>maven.antlr.src.dir</td>
<td>No</td>
<td>
Must be set to allow antlr processing to happen.
<strong>FIXME: It appears this property isn't used?</strong>
</td>
</tr>
</table>
</section>
<section name="Other properties used">
<table>
<tr>
<th>Property name</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>maven.build.dir</td>
<td>Yes</td>
<td>
This is the directory that output files are generated to. The
antlr generated code is placed in the <code>antlr</code>
directory below this
</td>
</tr>
<tr>
<td>maven.compile.src.set</td>
<td>Yes</td>
<td>
The source directories maven uses to compile java code.
The antlr plugin adds the directory it generates code to
this path, so that generated code is compiled seamlessly
</td>
</tr>
</table>
</section>
</body>
</document>
1.1 jakarta-turbine-maven/src/plugins-build/antlr/xdocs/changes.xml
Index: changes.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Changes</title>
<author email="[EMAIL PROTECTED]">dIon Gillard</author>
</properties>
<body>
<release version="1.1" date="in CVS">
<action dev="dion" type="add">
Added documentation for navigation, changes, properties and goals
</action>
</release>
<release version="1.0" date="2002-07-16">
<action dev="jvanzyl" type="add">
Original release for Maven 1.0-beta6
</action>
</release>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
