dion        2002/10/09 19:09:21

  Modified:    src/plugins-build/ant/xdocs navigation.xml
               src/plugins-build/aspectj project.xml
  Added:       src/plugins-build/aspectj/xdocs changes.xml index.xml
                        goals.xml navigation.xml properties.xml
               src/plugins-build/antlr/xdocs index.xml
  Log:
  More documentation
  
  Revision  Changes    Path
  1.4       +1 -1      jakarta-turbine-maven/src/plugins-build/ant/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: 
/home/cvs/jakarta-turbine-maven/src/plugins-build/ant/xdocs/navigation.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- navigation.xml    3 Oct 2002 08:17:11 -0000       1.3
  +++ navigation.xml    10 Oct 2002 02:09:21 -0000      1.4
  @@ -1,5 +1,5 @@
   <?xml version="1.0" encoding="ISO-8859-1"?>
  -<project name="Maven Activity Plugin">
  +<project name="Maven Ant Plugin">
   
     <title>Maven Ant Plugin</title>
   
  
  
  
  1.8       +1 -1      jakarta-turbine-maven/src/plugins-build/aspectj/project.xml
  
  Index: project.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/aspectj/project.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- project.xml       15 Sep 2002 16:56:45 -0000      1.7
  +++ project.xml       10 Oct 2002 02:09:21 -0000      1.8
  @@ -4,7 +4,7 @@
     <pomVersion>3</pomVersion>
     <id>maven-aspectj-plugin</id>
     <name>Maven AspectJ Plug-in</name>
  -  <currentVersion>1.0</currentVersion>
  +  <currentVersion>1.1-SNAPSHOT</currentVersion>
     <organization>
       <name>Apache Software Foundation</name>
       <url>http://jakarta.apache.org/</url>
  
  
  
  1.1                  
jakarta-turbine-maven/src/plugins-build/aspectj/xdocs/changes.xml
  
  Index: changes.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
    <properties>
      <title>Changes</title>
      <author email="[EMAIL PROTECTED]">dIon Gillard</author>
    </properties>
  
    <body>
      <release version="1.1" date="in CVS">
        <action dev="dion" type="add">
          Added documentation for navigation, changes, properties and goals
        </action>
      </release>
  
      <release version="1.0" date="2002-07-16">
        <action dev="jvanzyl" type="add">
          Original release for Maven 1.0-beta6
        </action>
      </release>
    </body>
  </document>
  
  
  
  
  1.1                  jakarta-turbine-maven/src/plugins-build/aspectj/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
  
    <properties>
      <title>Maven AspectJ Plug-in</title>
      <author email="[EMAIL PROTECTED]">dIon Gillard</author>
    </properties>
  
    <body>
      <section name="Maven AspectJ Plug-in">
        <p>
          This plugin provides the basic facilities for compiling
          code using AspectJ.
        </p>
        <p> 
          For more information on the functionality provided by this plugin,
          please see the <a href="goals.html">Goals</a> document.
        </p>
        <p>
          For more information on how to customise the functionality provided
          by this plugin, please see the <a href="properties.html">properties</a>
          document.
        </p>
      </section>
   </body>
  </document>
  
  
  
  1.1                  jakarta-turbine-maven/src/plugins-build/aspectj/xdocs/goals.xml
  
  Index: goals.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
  
    <properties>
      <title>Maven AspectJ Plug-in Goals</title>
      <author email="[EMAIL PROTECTED]">dIon Gillard</author>
    </properties>
  
    <body>
      <section name="Goals">
        <table>
          <tr><th>Goal</th><th>Description</th></tr>
          <tr>
            <td>aspectj</td>
            <td>
              This is the default goal of the plugin and simply attains
              the <code>aspectj:compile</code> goal.
            </td>
          </tr>
          <tr>
            <td>aspectj:compile</td>
            <td>
              Compiles source code as found in the
  <source><![CDATA[
  <build>
    <aspectSourceDirectory>...</aspectSourceDirectory>
  </build>
  ]]>
  </source>
              element from your
             <a 
href="http://jakarta.apache.org/turbine/maven/reference/project-descriptor.html";>
             project descriptor</a>
             <p>
               Code is only recompiled if any of the source is newer than
               the jar file
             </p>
            </td>
          </tr>
        </table>
      </section>
   </body>
  </document>
  
  
  
  1.1                  
jakarta-turbine-maven/src/plugins-build/aspectj/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <project name="Maven AspectJ Plugin">
  
    <title>Maven AspectJ Plugin</title>
  
    <body>
      <links>
        <item name="Maven"      href="http://jakarta.apache.org/turbine/maven/"/>
        <item name="AspectJ"    href="http://www.aspectj.org/"/>
      </links>
      <menu name="Overview">
        <item name="Goals"      href="/goals.html" />
        <item name="Properties" href="/properties.html" />
      </menu>
    </body>
  </project>
  
  
  
  1.1                  
jakarta-turbine-maven/src/plugins-build/aspectj/xdocs/properties.xml
  
  Index: properties.xml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <document>
  
    <properties>
      <title>Maven AspectJ Plugin Properties</title>
      <author email="[EMAIL PROTECTED]">dIon Gillard</author>
    </properties>
  
    <body>
      <section name="Maven AspectJ Plugin Settings">
        <table>
          <tr>
            <th>Property name</th>
            <th>Optional?</th>
            <th>Description</th>
          </tr>
          <tr>
            <td>maven.compile.debug</td>
            <td>Yes</td>
            <td>
              Specifies wether to include debugging information in the compiled
              class files; the default value is <code>on</code>.
              Used by the "java:compile" goal.
            </td>
          </tr>
          <tr>
            <td>maven.compile.deprecation</td>
            <td>Yes</td>
            <td>
              Specifies wether source should be compiled with deprecation
              information; the default value is <code>off</code>.
              Used by the "java:compile" goal.
            </td>
          </tr>
          <tr>
            <td>maven.compile.optimize</td>
            <td>Yes</td>
            <td>
              Specifies whether source should be compiled with optimization; the
              default value is <code>off</code>.  
              Used by the "java:compile" goal.
            </td>
          </tr>
          <tr>
            <td>maven.compile.src.set</td>
            <td>Yes</td>
            <td>
              The source directories maven uses to compile java code.
            </td>
          </tr>
          <tr>
            <td>pom.build.sourceModifications</td>
            <td>Yes</td>
            <td>
              This property is the list of the
                        <source><![CDATA[
  <build>
    <sourceModification>
      <sourceModification>
        <className></className>
        <excludes>
          <exclude></exclude>
        </excludes>
      </sourceModification>
    </sourceModification>
  </build>
  ]]></source>
             source modifications in your
             <a 
href="http://jakarta.apache.org/turbine/maven/reference/project-descriptor.html";>
             project descriptor</a>. This property is used during compilation to 
exclude or
             include classes from compilation depending on whether a named class is 
available
            </td>
          </tr>
        </table>
      </section>
      <section name="Other properties used">
        <table>
          <tr>
            <th>Property name</th>
            <th>Optional?</th>
            <th>Description</th>
          </tr>
          <tr>
            <td>sourcesPresent</td>
            <td>Yes</td>
            <td>
              This property is set by Maven to indicate the presence of
              Java source code for compilation. The plugin only attempts
              to compile AspectJ code if there is java source present.
            </td>
          </tr>
          <tr>
            <td>maven.build.dest</td>
            <td>Yes</td>
            <td>
              The destination directory for compiled code
            </td>
          </tr>
          <tr>
            <td>maven.dependency.classpath</td>
            <td>Yes</td>
            <td>
              This property holds the Ant <code>path</code> of all the dependent jar
              files listed in the <code>dependencies</code> block of your 
              <a 
href="http://jakarta.apache.org/turbine/maven/reference/project-descriptor.html";>
              project descriptor</a>
            </td>
          </tr>
        </table>
      </section>
    </body>
  </document>
  
  
  1.3       +16 -4     jakarta-turbine-maven/src/plugins-build/antlr/xdocs/index.xml
  
  
  
  

--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>

Reply via email to