cvs commit: spice/sandbox/metaclass/xdocs task.xml release-1_1.xml tool-guide.xml

Peter Donald <[email protected]>
Newsgroups gmane.comp.java.spice.cvs
Message-ID <[email protected]>
donaldp     03/10/31 17:53:10

  Modified:    sandbox/metaclass/xdocs release-1_1.xml tool-guide.xml
  Added:       sandbox/metaclass/xdocs task.xml
  Log:
  Document ant task
  
  Revision  Changes    Path
  1.10      +3 -0      spice/sandbox/metaclass/xdocs/release-1_1.xml
  
  Index: release-1_1.xml
  ===================================================================
  RCS file: /cvsroot/spice/spice/sandbox/metaclass/xdocs/release-1_1.xml,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- release-1_1.xml	1 Nov 2003 01:37:14 -0000	1.9
  +++ release-1_1.xml	1 Nov 2003 01:53:10 -0000	1.10
  @@ -92,6 +92,9 @@
                       The runtime will attempt to load XML descriptors if binary
                       descriptors are not present.
                   </li>
  +                <li>
  +                    Documented the ant task.
  +                </li>
               </ul>
           </section>
       </body>
  
  
  
  1.2       +1 -0      spice/sandbox/metaclass/xdocs/tool-guide.xml
  
  Index: tool-guide.xml
  ===================================================================
  RCS file: /cvsroot/spice/spice/sandbox/metaclass/xdocs/tool-guide.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- tool-guide.xml	28 Sep 2003 06:37:34 -0000	1.1
  +++ tool-guide.xml	1 Nov 2003 01:53:10 -0000	1.2
  @@ -16,6 +16,7 @@
                   <li><a href="precompile.html">Pre-Compilation</a></li>
                   <li><a href="filtering.html">Pre-Compilation Filtering</a></li>
                   <li><a href="interception.html">Pre-Compilation Interception</a></li>
  +                <li><a href="task.html">Ant Task Reference</a></li>
               </ul>
           </section>
       </body>
  
  
  
  1.1                  spice/sandbox/metaclass/xdocs/task.xml
  
  Index: task.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
  
      <properties>
          <title>Ant Task Reference</title>
          <author email="peter at realityforge.org">Peter Donald</author>
      </properties>
  
      <body>
          <section name="Introduction">
              <p>
                  The ant task is used to generate the MetaClass descriptors
                  from annotated Java source files. The following table lists
                  the attributes for ant task
              </p>
              <table>
                  <tr>
                      <td>Name</td>
                      <td>Description</td>
                      <td>Optional?</td>
                      <td>Default Value</td>
                  </tr>
                  <tr>
                      <td>destDir</td>
                      <td>
                          The destination directory where descriptors
                          are generated.
                      </td>
                      <td>Required</td>
                      <td>n/a</td>
                  </tr>
                  <tr>
                      <td>namespaceTagsOnly</td>
                      <td>
                          A flag indicating whether attributes without any
                          namespace (ie are not of form X.Y) should be added
                          to descriptors. Valid values include true and false.
                      </td>
                      <td>Optional</td>
                      <td>true</td>
                  </tr>
              </table>
              <p>
                  The task also accepts child elements;
              </p>
              <ul>
                  <li>
                      <a href="http://ant.apache.org/manual/CoreTypes/fileset.html">
                      FileSet</a>: Defines the files processed by task.
                  </li>
                  <li>
                      <a href="interception.html">Interceptor</a>: Defines
                      interceptors applied to generation.
                  </li>
                  <li>
                      <a href="filtering.html">Filter</a>: Defines filter
                      applied to generation.
                  </li>
              </ul>
              <p>
                  The Interceptor and Filter elements both accept a name parameter
                  that defines the name of the class. The also contain a
                  "classpath" element which is a
                  <a href="http://ant.apache.org/manual/using.html#path">path-like</a>
                  structure that defines the classpath used to load either the
                  filter or interceptor.
              </p>
          </section>
      </body>
  
  </document>
  
  
  


-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?   SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.