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

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

Author: jesper.pedersen
Date: 2010-06-14 09:52:08 -0400 (Mon, 14 Jun 2010)
New Revision: 106032

Modified:
   projects/jboss-jca/trunk/doc/userguide/en/modules/codegenerator.xml
Log:
A nit more documentation for the code generator

Modified: projects/jboss-jca/trunk/doc/userguide/en/modules/codegenerator.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/codegenerator.xml	2010-06-14 13:17:48 UTC (rev 106031)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/codegenerator.xml	2010-06-14 13:52:08 UTC (rev 106032)
@@ -15,13 +15,22 @@
       <title>Functionality</title>
 
       <para>The code generator will generate a resource adapter code skeleton based
-        on the user input. Currently the focus is on</para>
+        on the user input. The code generator supports</para>
 
       <itemizedlist spacing="compact">
         <listitem>
           Resource adapter using JCA 1.6 annotations
         </listitem>
         <listitem>
+          Resource adapter using JCA 1.6 metadata
+        </listitem>
+        <listitem>
+          Resource adapter using JCA 1.5
+        </listitem>
+        <listitem>
+          Resource adapter using JCA 1.0
+        </listitem>
+        <listitem>
           Apache Ant build environment
         </listitem>
       </itemizedlist>
@@ -68,4 +77,61 @@
 
    </section>
 
+   <section id="codegenerator_code">
+      <title>Generated code</title>
+
+      <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>
+
+      <table frame="all">
+        <title>Apache Ant 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>
+
 </chapter>