maven-plugins/antlr/xdocs/properties.xml
evenisse 9a278f5c42 Update to ASL v.2
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114791 13f79535-47bb-0310-9956-ffa450edef68
2004-03-04 18:05:31 +00:00

86 lines
2.4 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>Maven Antlr Plugin Properties</title>
<author email="dion@multitask.com.au">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.
</td>
</tr>
<tr>
<td>maven.antlr.target.dir</td>
<td>Yes - defaults to ${maven.build.dir}/antlr</td>
<td>
Defines where antlr will process .g files to.
</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>