[jboss-cvs] JBossAS SVN: r108034 - projects/jboss-jca/trunk/doc/userguide/en/modules.

[jboss-cvs-commits at lists.jboss.org]

Author: jeff.zhang
Date: 2010-09-08 04:23:53 -0400 (Wed, 08 Sep 2010)
New Revision: 108034

Modified:
   projects/jboss-jca/trunk/doc/userguide/en/modules/codegenerator.xml
Log:
codegenerator document for maven support

Modified: projects/jboss-jca/trunk/doc/userguide/en/modules/codegenerator.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/codegenerator.xml	2010-09-08 05:37:36 UTC (rev 108033)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/codegenerator.xml	2010-09-08 08:23:53 UTC (rev 108034)
@@ -34,6 +34,12 @@
           Apache Ant build environment
         </listitem>
         <listitem>
+          Apache Ant + Ivy build environment
+        </listitem>
+        <listitem>
+          Apache Maven build environment
+        </listitem>
+        <listitem>
           Test suite environment
         </listitem>
       </itemizedlist>
@@ -124,6 +130,26 @@
               </row>
               <row>
                 <entry>
+                  Transaction support (N/NoTransaction/L/LocalTransaction/X/XATransaction)
+                </entry>
+                <entry>All</entry>
+                <entry>
+                  The transaction support level
+                </entry>
+                <entry></entry>
+              </row>
+              <row>
+                <entry>
+                  Package name
+                </entry>
+                <entry>All</entry>
+                <entry>
+                  The package name of the resource adapter
+                </entry>
+                <entry></entry>
+              </row>
+              <row>
+                <entry>
                   Use annotations (Y/Yes/N/No)
                 </entry>
                 <entry>JCA 1.6+</entry>
@@ -145,16 +171,6 @@
               </row>
               <row>
                 <entry>
-                  Package name
-                </entry>
-                <entry>All</entry>
-                <entry>
-                  The package name of the resource adapter
-                </entry>
-                <entry></entry>
-              </row>
-              <row>
-                <entry>
                   Resource adapter class name 
                 </entry>
                 <entry>JCA 1.5+</entry>
@@ -306,12 +322,22 @@
               </row>
               <row>
                 <entry>
-                  Transaction support (N/NoTransaction/L/LocalTransaction/X/XATransaction)
+                  Add methods to connection interface (Y/Yes/N/No) [N]:
                 </entry>
                 <entry>All</entry>
                 <entry>
-                  The transaction support level
+                  Use for add methods to connection interface
                 </entry>
+                <entry>Outbound or Bidirectional</entry>
+              </row>
+              <row>
+                <entry>
+                  Build environment [A/Ant/I/Ant+Ivy/M/Maven]
+                </entry>
+                <entry>All</entry>
+                <entry>
+                  Create build environment, ant or ant+ivy or maven
+                </entry>
                 <entry></entry>
               </row>
             </tbody>
@@ -328,7 +354,9 @@
       <para>The generated code will consist of the classes making up the resource adapter
         and a test suite environment based on the embedded distribution.</para>
 
-      <para>The following targets are supported in the Apache Ant build environment</para>
+      <section id="codegenerator_ant">
+        <title>Apache Ant build environment</title>
+        <para>The following targets are supported in the Apache Ant build environment</para>
 
       <table frame="all">
         <title>Apache Ant build environment</title>
@@ -375,8 +403,91 @@
           </tbody>
         </tgroup>
       </table>
+      </section>
 
+      <section id="codegenerator_ant_ivy">
+        <title>Apache Ant + Ivy build environment</title>
+        <para>The following targets are supported in the Apache Ant + Ivy build environment</para>
 
+      <table frame="all">
+        <title>Apache Ant + Ivy build environment</title>
+        <tgroup cols="2" align="left" colsep="1" rowsep="1">
+          <colspec colname="c1" colwidth="2*"/>
+          <colspec colname="c2" colwidth="3*"/>
+          <thead>
+            <row>
+              <entry align="left">Target</entry>
+              <entry align="left">Desciption</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><code>compile</code></entry>
+              <entry>
+                Compiles all the files
+              </entry>
+            </row>
+            <row>
+              <entry><code>rar</code></entry>
+              <entry>
+                Builds the resource adapter archive
+              </entry>
+            </row>
+            <row>
+              <entry><code>prepare-test</code></entry>
+              <entry>
+                Prepares the test environment
+              </entry>
+            </row>
+            <row>
+              <entry><code>test</code></entry>
+              <entry>
+                Executes the tests
+              </entry>
+            </row>
+            <row>
+              <entry><code>docs</code></entry>
+              <entry>
+                Generates the documentation
+              </entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </table>
+      </section>
+
+      <section id="codegenerator_maven">
+        <title>Apache Maven build environment</title>
+        <para>The following targets are supported in the Apache Maven build environment</para>
+
+      <table frame="all">
+        <title>Apache Maven build environment</title>
+        <tgroup cols="2" align="left" colsep="1" rowsep="1">
+          <colspec colname="c1" colwidth="2*"/>
+          <colspec colname="c2" colwidth="3*"/>
+          <thead>
+            <row>
+              <entry align="left">Target</entry>
+              <entry align="left">Desciption</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><code>compile</code></entry>
+              <entry>
+                Compiles all the files
+              </entry>
+            </row>
+            <row>
+              <entry><code>test</code></entry>
+              <entry>
+                Executes the tests
+              </entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </table>
+      </section>
    </section>
 
 </chapter>