Documentation for the antlr task.

Submitted by: Erik Meade <emeade@geekfarm.org> git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@268178 13f79535-47bb-0310-9956-ffa450edef68
24 years ago · e64c186c50
--- a/docs/antlr.html
+++ b/docs/antlr.html
@@ -0,0 +1,72 @@
 <html>

 <head>
 <meta http-equiv="Content-Language" content="en-us">
 <title>ANTLR Task</title>
 </head>

 <body>

 <h2><a name="antlr">ANTLR</a></h2>
 <h3>Description</h3>
 <p>
  Invokes the <a HREF="http://www.antlr.org/">ANTLR</a> Translator generator
  on a grammar file.
 </p>
 <p>
  To use the ANTLR task, set the <i>target</i> attribute to the name of the
  grammar file to process.  Optionally, you can also set the
  <i>outputdirectory</i> to write the generated file to a specific directory.
  Otherwise ANTLR writes the generated files to the directory containing
  the grammar file.
 </p>
 <p>
  This task only invokes ANTLR if the grammar file is newer than the generated
  files.
 </p>

 <h3>Parameters</h3>
 <table border="1" cellpadding="2" cellspacing="0">
  <tr>
    <td valign="top"><b>Attribute</b></td>
    <td valign="top"><b>Description</b></td>
    <td align="center" valign="top"><b>Required</b></td>
  </tr>
  <tr>
    <td valign="top">target</td>
    <td valign="top">The grammar file to process.</td>
    <td valign="top" align="center">Yes</td>
  </tr>
  <tr>
    <td valign="top">outputdirectory</td>
    <td valign="top">
      The directory to write the generated files to.  If not set, the files
      are written to the directory containing the grammar file.
    </td>
    <td valign="top" align="center">No</td>
  </tr>
  <tr>
    <td valign="top">fork</td>
    <td valign="top">Run ANTLR in a separate VM.</td>
    <td align="center" valign="top">No, default is "off"</td>
  </tr>
  <tr>
    <td valign="top">dir</td>
    <td valign="top">The directory to invoke the VM in. (ignored if
      fork is disabled)</td>
    <td align="center" valign="top">No</td>
  </tr>
 </table>
 <h3>Example</h3>
 <blockquote><pre>
 &lt;antlr
    target=&quot;etc/java.g&quot;
    outputdirectory=&quot;build/src&quot;
 /&gt;
 </pre></blockquote>
 <p>
  This invokes ANTLR on grammar file etc/java.g, writing the generated
  files to build/src.
 </p>
 <hr>

--- a/docs/index.html
+++ b/docs/index.html
@@ -20,13 +20,14 @@
  <li>Arnout J. Kuiper (<a href="mailto:ajkuiper@wxs.nl">ajkuiper@wxs.nl</a>)</li>
  <li>Conor MacNeill (<a href="mailto:conor@cortexebusiness.com.au">conor@cortexebusiness.com.au</a>)</li>
  <li>Stefano Mazzocchi (<a href="mailto:stefano@apache.org">stefano@apache.org</a>)</li>
  <li>Erik Meade (<a href="mailto:emeade@geekfarm.org">emeade@geekfarm.org</a>)</li>
  <li>Sam Ruby (<a href="mailto:rubys@us.ibm.com">rubys@us.ibm.com</a>)</li>
  <li>Nico Seessle (<a href="mailto:nico@seessle.de">nico@seessle.de</a>)</li>
  <li>Roger Vaughn (<a href="mailto:rvaughn@seaconinc.com">rvaughn@seaconinc.com</a>)</li>
  <li>Dave Walend (<a href="mailto:dwalend@cs.tufts.edu">dwalend@cs.tufts.edu</a>)</li>
 </ul>

 <p>Version 1.3 - 2000/11/10</p>
 <p>Version 1.3 - 2000/11/14</p>

 <hr>
 <h2>Table of Contents</h2>
@@ -4536,8 +4537,10 @@ it had been located at <code>htdocs/manual/ChangeLog.txt</code>.</p>
 <hr>
 <h2><a name="optionaltasks">Optional tasks</a></h2>
 <ul>
  <li><a href="dotnet.html">.NET tasks</a></li>
  <li><a href="dotnet.html">.NET Tasks</a></li>
  <li><a href="antlr.html">ANTLR</a></li>
  <li><a href="#cab">Cab</a></li>
  <li><a href="ejb.html">EJB Tasks</a></li>
  <li><a href="#ftp">FTP</a></li>
  <li><a href="javacc.html">JavaCC</a></li>
  <li><a href="jlink.html">Jlink</a></li>
@@ -4549,7 +4552,6 @@ it had been located at <code>htdocs/manual/ChangeLog.txt</code>.</p>
  <li><a href="#renameexts">RenameExtensions</a></li>
  <li><a href="#script">Script</a></li>
  <li><a href="#vssget">VssGet</a></li>
  <li><a href="ejb.html">EJB Tasks</a></li>
 </ul>
 <hr>
 <h2><a name="cab">Cab</a></h2>
--- a/docs/javacc.html
+++ b/docs/javacc.html
@@ -160,7 +160,7 @@
 <blockquote><pre>
 &lt;javacc 
    target=&quot;src/Parser.jj&quot; 
    outputdirectory&quot;build/src&quot;
    outputdirectory=&quot;build/src&quot;
    javacchome=&quot;c:/program files/JavaCC&quot; 
    static=&quot;true&quot;
 /&gt;