minor 1.5.1 -> 1.6.0 doc updates

svn-rev: tags/release_1_6_0@845
jflex-de · Jun 21, 2014 · 162fb48 · 162fb48
1 parent 778ae09
commit 162fb48
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 45 deletions.
diff --git a/jflex-maven-plugin/pom.xml b/jflex-maven-plugin/pom.xml
@@ -7,7 +7,7 @@
 	<name>JFlex Maven Plugin</name>
 	<version>1.6.0</version>
 	<description>
-      This is a Maven 2 plugin to generate a parser in Java code from
+      This is a Maven 2/3 plugin to generate a parser in Java code from
       a Lexer definition, using JFlex.
 
       This plugin was previously called maven-jflex-plugin.
@@ -49,7 +49,7 @@
 	<developers>
 		<developer>
 			<id>decamps</id>
-			<name>Régis Décamps</name>
+			<name>Régis Décamps</name>
 			<email>[email protected]</email>
 			<roles>
 				<role>developer</role>

diff --git a/jflex-maven-plugin/src/main/java/de/jflex/plugin/maven/JFlexMojo.java b/jflex-maven-plugin/src/main/java/de/jflex/plugin/maven/JFlexMojo.java
@@ -1,6 +1,6 @@
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * JFlex Maven2 plugin                                                     *
- * Copyright (c) 2007       Régis Décamps <[email protected]>           *
+ * Copyright (c) 2007       Régis Décamps <[email protected]>           *
  * All rights reserved.                                                    *
  *                                                                         *
  * License: BSD                                                            *
@@ -31,7 +31,7 @@
  * 
  * @goal generate
  * @phase generate-sources
- * @author Régis Décamps ([email protected])
+ * @author Régis Décamps ([email protected])
  * 
  */
 public class JFlexMojo extends AbstractMojo {
@@ -143,7 +143,7 @@ public class JFlexMojo extends AbstractMojo {
      * If true, the generated scanner will include a constructor taking
      * an InputStream.
      * 
-     * @parameter default-value="true"
+     * @parameter default-value="false"
      */
     private boolean inputStreamCtor = false; // NOPMD
 

diff --git a/jflex-maven-plugin/src/site/apt/changelog.apt b/jflex-maven-plugin/src/site/apt/changelog.apt
@@ -4,13 +4,20 @@
 
 Latest version
 
+* Version 1.6.0
+
+   * Relies on JFlex 1.6.0
+
+   * changed inputStreamCtor default to false
+
+
 * Version 1.5.0
 
   * Changed name from maven-jflex-plugin to jflex-maven-plugin
 
   * Switched license from GPL to BSD
 
-  * Relies on JFlex 1.6.0
+  * Relies on JFlex 1.5.0
 
   * Requires Java 5
 

diff --git a/jflex-maven-plugin/src/site/apt/usage.apt b/jflex-maven-plugin/src/site/apt/usage.apt
@@ -1,16 +1,17 @@
  ------
  Usage 
  ------
- Régis Décamps <[email protected]>
+ R�gis D�camps <[email protected]>,
+ minor updates by Gerwin Klein <[email protected]>
  ------
- 16 February 2009
+ 21 June 2014
  ------
 
 
 About this document
 
 	This document describes how to use jflex-maven-plugin, 
-	a Maven 2 plugin to call JFlex.
+	a Maven 3 plugin to call JFlex.
 
 	JFlex is a parser generator. Given a grammar, JFlex generates
 	Java (TM) code to parse documents that follow this grammar.
@@ -46,7 +47,7 @@ Usage
       <plugin>
         <groupId>de.jflex</groupId>
         <artifactId>jflex-maven-plugin</artifactId>
-        <version>1.5.0</version>
+        <version>1.6.0</version>
         <executions>
           <execution>
             <goals>
@@ -77,7 +78,7 @@ Usage
       <plugin>
         <groupId>de.jflex</groupId>
         <artifactId>jflex-maven-plugin</artifactId>
-        <version>1.5.0</version>
+        <version>1.6.0</version>
         <executions>
           <execution>
             <goals>
@@ -116,7 +117,7 @@ Usage
       <plugin>
         <groupId>de.jflex</groupId>
         <artifactId>jflex-maven-plugin</artifactId>
-        <version>1.5.0</version>
+        <version>1.6.0</version>
         <executions>
           <execution>
             <id>strict jlex</id>

diff --git a/jflex-maven-plugin/src/site/site.xml b/jflex-maven-plugin/src/site/site.xml
@@ -11,7 +11,7 @@
 	<poweredBy>  
        <logo name="Hosted on SourceForge.net" href="http://sourceforge.net/projects/jflex/"  
              img="http://sflogo.sourceforge.net/sflogo.php?group_id=14929&amp;type=1" />  
-       <logo name="Build with Maven 2" href="http://maven.apache.org/" 
+       <logo name="Build with Maven 3" href="http://maven.apache.org/" 
              img="images/logos/maven-feather.png" />  
      </poweredBy>  
 </project>
diff --git a/jflex/doc/jflex_anttask.html b/jflex/doc/jflex_anttask.html
@@ -113,26 +113,6 @@ <h3>Parameters</h3>
     <td align="center" valign="top">No</td>
     <td align="center" valign="top">&quot;off&quot;</td>
   </tr>
-  <tr>
-    <td valign="top">switch</td>
-    <td valign="top">Use code generation method <i>switch</i>.
-        <p><b>Deprecated - will be removed in JFlex 1.6.</b></td>
-    <td align="center" valign="top">No</td>
-    <td align="center" valign="top">&quot;off&quot;</td>
-  </tr>
-  <tr>
-    <td valign="top">table</td>
-    <td valign="top">Use code generation method <i>table</i>.
-        <p><b>Deprecated - will be removed in JFlex 1.6.</b></td>
-    <td align="center" valign="top">No</td>
-    <td align="center" valign="top">&quot;off&quot;</td>
-  </tr>
-  <tr>
-    <td valign="top">pack</td>
-    <td valign="top">Use code generation method <i>pack</i>.</td>
-    <td align="center" valign="top">No</td>
-    <td align="center" valign="top">&quot;on&quot;</td>
-  </tr>
   <tr>
     <td valign="top">legacydot</td>
     <td valign="top">Dot (.) metacharacter matches <tt>[^\n]</tt> 
@@ -144,7 +124,7 @@ <h3>Parameters</h3>
     <td valign="top">noinputstreamctor</td>
     <td valign="top">Don't include an InputStream constructor in the generated scanner</td>
     <td align="center" valign="top">No</td>
-    <td align="center" valign="top">&quot;off&quot;</td>
+    <td align="center" valign="top">&quot;true&quot;</td>
   </tr>
 </table>
 <h3>Example</h3>

diff --git a/tex/manual.tex b/tex/manual.tex
@@ -27,6 +27,7 @@
 \newcommand{\trit}{\em}
 
 \newcommand{\ver}{1.6}
+\newcommand{\longver}{1.6.0}
 \newcommand{\nextver}{1.7}
 \newcommand{\latestunicodever}{7.0}
 
@@ -126,7 +127,7 @@ \subsubsection{Windows\label{install:windows}}
 \\
 \\
 {\xsmall\texttt{
-C:\bs jflex-\ver\bs\\ 
+C:\bs jflex-\longver\bs\\ 
 \phantom{}~~~~+\dd bin\bs~~~~~~~~~~~~~~~~~~~~~~~~(start scripts)\\
 \phantom{}~~~~+\dd doc\bs~~~~~~~~~~~~~~~~~~~~~~~~(FAQ and manual)\\
 \phantom{}~~~~+\dd examples\bs\\ 
@@ -154,7 +155,7 @@ \subsubsection{Windows\label{install:windows}}
 
 \item
 Edit the file {\bf \verb+bin\jflex.bat+}
-(in the example it's \texttt{C:\bs jflex-\ver\bs bin\bs jflex.bat})
+(in the example it's \texttt{C:\bs jflex-\longver\bs bin\bs jflex.bat})
 such that
 
 \begin{itemize}
@@ -163,12 +164,12 @@ \subsubsection{Windows\label{install:windows}}
   (for instance \verb+C:\java+) and
 \item
   {\bf \texttt{JFLEX\_HOME}} the directory that contains JFlex (in the example:
-  \texttt{C:\bs jflex-\ver})
+  \texttt{C:\bs jflex-\longver})
 \end{itemize}
  
 \item
 Include the \verb+bin\+ directory of JFlex in your path.
-(the one that contains the start script, in the example: \texttt{C:\bs jflex-\ver\bs bin}).
+(the one that contains the start script, in the example: \texttt{C:\bs jflex-\longver\bs bin}).
 \end{enumerate}
 
 \subsubsection{Unix with tar archive}
@@ -179,7 +180,7 @@ \subsubsection{Unix with tar archive}
   Decompress the archive into a directory of your choice
   with GNU tar, for instance to \texttt{/usr/share}:
 
-  \texttt{tar -C /usr/share -xvzf jflex-\ver.tar.gz}
+  \texttt{tar -C /usr/share -xvzf jflex-\longver.tar.gz}
   
   (The example is for site wide installation. You need to
   be root for that. User installation works exactly the
@@ -190,7 +191,7 @@ \subsubsection{Unix with tar archive}
   Make a symbolic link from somewhere in your binary 
   path to \texttt{bin/jflex}, for instance:
 
-  \texttt{ln -s /usr/share/jflex-\ver/bin/jflex /usr/bin/jflex}
+  \texttt{ln -s /usr/share/jflex-\longver/bin/jflex /usr/bin/jflex}
 
   If the Java interpreter is not in your binary path, you
   need to supply its location in the script \texttt{bin/jflex}.
@@ -201,11 +202,11 @@ \subsubsection{Unix with tar archive}
 If you put the checksum file in the same directory
 as the archive, you run:
 
-\verb+md5sum --check +\texttt{jflex-\ver.tar.gz.md5}
+\verb+md5sum --check +\texttt{jflex-\longver.tar.gz.md5}
 
 It should tell you
 
-\texttt{jflex-\ver.tar.gz: OK}
+\texttt{jflex-\longver.tar.gz: OK}
 
 
 \subsection{Running JFlex}
@@ -214,7 +215,7 @@ \subsection{Running JFlex}
 \texttt{jflex <options> <inputfiles>}
 
 It is also possible to skip the start script in \verb+bin/+
-and include the file \texttt{lib/jflex-\ver.jar}
+and include the file \texttt{lib/jflex-\longver.jar}
 in your \texttt{CLASSPATH} environment variable instead.
 
 Then you run JFlex with:
@@ -223,7 +224,7 @@ \subsection{Running JFlex}
 
 or with:
 
-\texttt{java -jar jflex-\ver.jar <options> <inputfiles>}
+\texttt{java -jar jflex-\longver.jar <options> <inputfiles>}
 
 The input files and options are in both cases optional. If you don't
 provide a file name on the command line, JFlex will pop up a window
@@ -1861,7 +1862,7 @@ \subsubsection{Scanner methods and fields accessible in actions (API)\label{Scan
  reads from a new stream. Lexical state, line,
  char, and column counting remain untouched.
  The current input stream can be restored with
- \texttt{yypopstream} (usually in an \texttt{<<EOF>>} action).
+ \texttt{yypopStream} (usually in an \texttt{<<EOF>>} action).
  
  A typical example for this are include files in
  style of the C pre-processor. The corresponding