cvs commit: jakarta-ant/docs antlr.html index.html javacc.html

14 Nov 2000 09:30:40 -0000 

bodewig     00/11/14 01:30:39

  Modified:    docs     index.html javacc.html
  Added:       docs     antlr.html
  Log:
  Documentation for the antlr task.
  
  Submitted by: Erik Meade <[EMAIL PROTECTED]>
  
  Revision  Changes    Path
  1.150     +5 -3      jakarta-ant/docs/index.html
  
  Index: index.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/index.html,v
  retrieving revision 1.149
  retrieving revision 1.150
  diff -u -r1.149 -r1.150
  --- index.html        2000/11/10 17:07:20     1.149
  +++ index.html        2000/11/14 09:30:38     1.150
  @@ -20,13 +20,14 @@
     <li>Arnout J. Kuiper (<a href="mailto:[EMAIL PROTECTED]">[EMAIL 
PROTECTED]</a>)</li>
     <li>Conor MacNeill (<a href="mailto:[EMAIL PROTECTED]">[EMAIL 
PROTECTED]</a>)</li>
     <li>Stefano Mazzocchi (<a href="mailto:[EMAIL PROTECTED]">[EMAIL 
PROTECTED]</a>)</li>
  +  <li>Erik Meade (<a href="mailto:[EMAIL PROTECTED]">[EMAIL 
PROTECTED]</a>)</li>
     <li>Sam Ruby (<a href="mailto:[EMAIL PROTECTED]">[EMAIL 
PROTECTED]</a>)</li>
     <li>Nico Seessle (<a href="mailto:[EMAIL PROTECTED]">[EMAIL 
PROTECTED]</a>)</li>
     <li>Roger Vaughn (<a href="mailto:[EMAIL PROTECTED]">[EMAIL 
PROTECTED]</a>)</li>
     <li>Dave Walend (<a href="mailto:[EMAIL PROTECTED]">[EMAIL 
PROTECTED]</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 @@
   <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 @@
     <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>
  
  
  
  1.2       +1 -1      jakarta-ant/docs/javacc.html
  
  Index: javacc.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/javacc.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- javacc.html       2000/09/28 13:46:30     1.1
  +++ javacc.html       2000/11/14 09:30:38     1.2
  @@ -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;
  
  
  
  1.1                  jakarta-ant/docs/antlr.html
  
  Index: antlr.html
  ===================================================================
  <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>

Reply via email to