svn commit: r427021 - in /maven/plugins/trunk/maven-javadoc-plugin/src: main/java/org/apache/maven/plugin/javadoc/ site/ site/apt/ site/apt/examples/

oching Sun, 30 Jul 2006 23:00:10 -0700

Author: oching
Date: Sun Jul 30 22:59:47 2006
New Revision: 427021

URL: http://svn.apache.org/viewvc?rev=427021&view=rev
Log:
Updated description of some of the mojo parameters. Changed <build> to 
<reporting> in the example poms. Updated site.xml.


Modified:
    
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
    
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java
    maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt
    
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/exclude-package-names.apt
    
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt
    
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt
    
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt
    maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/usage.apt
    maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml

Modified: 
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java?rev=427021&r1=427020&r2=427021&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
 (original)
+++ 
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
 Sun Jul 30 22:59:47 2006
@@ -206,7 +206,7 @@
     private int proxyPort;
 
     /**
-     * This option created documentation with the appearance and functionality 
of documentation generated by Javadoc 1.1.
+     * This option creates documentation with the appearance and functionality 
of documentation generated by Javadoc 1.1.
      * See <a 
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#1.1";>1.1</a>.
      *
      * @parameter expression="${old}" default-value="false"
@@ -346,11 +346,11 @@
      * See <a 
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#group";>group</a>.
      * Example:
      * <pre>
-     * &lt;groups&gt;
-     *   &lt;group&gt;
-     *     &lt;title&gt;Core Packages&lt;/title&gt;
-     *     &lt;packages&gt;org.apache.core&lt;/packages&gt;
-     *   &lt;/group&gt;
+     * &lt;groups&gt;<br/>
+     *   &lt;group&gt;<br/>
+     *     &lt;title&gt;Core Packages&lt;/title&gt;<br/>
+     *     &lt;packages&gt;org.apache.core&lt;/packages&gt;<br/>
+     *   &lt;/group&gt;<br/>
      *  &lt;/groups&gt;
      * </pre>
      *
@@ -400,7 +400,7 @@
 
     /**
      * Suppress the entire comment body, including the main description and 
all tags, generating only declarations.
-     * Ssee <a 
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#nocomment";>nocomment</a>.
+     * See <a 
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#nocomment";>nocomment</a>.
      *
      * @parameter expression="${nocomment}" default-value="false"
      */
@@ -439,7 +439,7 @@
     private boolean noindex = false;
 
     /**
-     * Omits the index from the generated docs. The default value is 'false'.
+     * Omits the navigation bar from the generated docs.
      * See <a 
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#nonavbar";>nonavbar</a>.
      *
      * @parameter expression="${nonavbar}" default-value="false"
@@ -507,12 +507,12 @@
      * See <a 
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tag";>tag</a>.
      * Example:
      * <pre>
-     * &lt;tags&gt;
-     *   &lt;tag&gt;
-     *     &lt;name&gt;todo&lt;/name&gt;
-     *     &lt;placement&gt;a&lt;/placement&gt;
-     *     &lt;head&gt;To Do:&lt;/head&gt;
-     *   &lt;/tag&gt;
+     * &lt;tags&gt;<br/>
+     *   &lt;tag&gt;<br/>
+     *     &lt;name&gt;todo&lt;/name&gt;<br/>
+     *     &lt;placement&gt;a&lt;/placement&gt;<br/>
+     *     &lt;head&gt;To Do:&lt;/head&gt;<br/>
+     *   &lt;/tag&gt;<br/>
      *  &lt;/tags&gt;
      * </pre>
      *
@@ -538,7 +538,7 @@
 
     /**
      * Includes one "Use" page for each documented class and package.
-     * See <a 
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#use";>use</a>.
+     * See <a 
href="http://java.sun.com/j2se/1.4.2/docs/tooldoldocs/windows/javadoc.html#use";>use</a>.
      *
      * @parameter expression="${use}" default-value="true"
      */
@@ -554,7 +554,6 @@
 
     /**
      * Specifies the title to be placed in the HTML title tag.
-     * The default is '${project.name} ${project.version} API'.
      * See <a 
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#windowtitle";>windowtitle</a>.
      *
      * @parameter expression="${windowtitle}" default-value="${project.name} 
${project.version} API"

Modified: 
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java?rev=427021&r1=427020&r2=427021&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java
 (original)
+++ 
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java
 Sun Jul 30 22:59:47 2006
@@ -53,7 +53,7 @@
     private String jarOutputDirectory;
 
     /**
-     * Specified the filename that will be used for the generated jar file. 
Please note that "-javadoc"
+     * Specifies the filename that will be used for the generated jar file. 
Please note that "-javadoc"
      * will be appended to the file name.
      *
      * @parameter expression="${project.build.finalName}"

Modified: 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt?rev=427021&r1=427020&r2=427021&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt 
(original)
+++ 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt 
Sun Jul 30 22:59:47 2006
@@ -36,7 +36,7 @@
 +-----+
 <project>
   ...
-  <build>
+  <reporting>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -49,7 +49,7 @@
       </plugin>
     </plugins>
   ...
-  </build>
+  </reporting>
   ...
 </project>
 +-----+

Modified: 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/exclude-package-names.apt
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/exclude-package-names.apt?rev=427021&r1=427020&r2=427021&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/exclude-package-names.apt
 (original)
+++ 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/exclude-package-names.apt
 Sun Jul 30 22:59:47 2006
@@ -16,7 +16,7 @@
 +-----+
 <project>
   ...
-  <build>
+  <reporting>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -29,7 +29,7 @@
       </plugin>
     </plugins>
   ...
-  </build>
+  </reporting>
   ...
 </project>
 +-----+

Modified: 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt?rev=427021&r1=427020&r2=427021&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt
 (original)
+++ 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt
 Sun Jul 30 22:59:47 2006
@@ -15,7 +15,7 @@
 +-----+
 <project>
   ...
-  <build>
+  <reporting>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -37,7 +37,7 @@
       </plugin>
     </plugins>
   ...
-  </build>
+  </reporting>
   ...
 </project>
 +-----+

Modified: 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt?rev=427021&r1=427020&r2=427021&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt
 (original)
+++ 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt
 Sun Jul 30 22:59:47 2006
@@ -17,7 +17,7 @@
 +-----+
 <project>
   ...
-  <build>
+  <reporting>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -30,7 +30,7 @@
       </plugin>
     </plugins>
   ...
-  </build>
+  </reporting>
   ...
 </project>
 +-----+

Modified: 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt?rev=427021&r1=427020&r2=427021&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt
 (original)
+++ 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt
 Sun Jul 30 22:59:47 2006
@@ -15,7 +15,7 @@
 +-----+
 <project>
   ...
-  <build>
+  <reporting>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -35,7 +35,7 @@
       </plugin>
     </plugins>
   ...
-  </build>
+  </reporting>
   ...
 </project>
 +-----+

Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/usage.apt
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/usage.apt?rev=427021&r1=427020&r2=427021&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/usage.apt Sun Jul 30 
22:59:47 2006
@@ -24,11 +24,6 @@
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
-     <configuration>
-       <minmemory>128m</minmemory>
-       <maxmemory>512m</maxmemory>
-       ...
-     </configuration>
    </plugin>
  </plugins>
 ...

Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml?rev=427021&r1=427020&r2=427021&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml Sun Jul 30 
22:59:47 2006
@@ -18,9 +18,9 @@
  */
 -->
 
-<project name="Maven Javadoc Report">
+<project name="Maven 2 Javadoc Plugin">
   <bannerLeft>
-    <name>Maven Javadoc Report</name>
+    <name>Maven 2 Javadoc Plugin</name>
     <src>http://maven.apache.org/images/apache-maven-project.png</src>
     <href>http://maven.apache.org/</href>
   </bannerLeft>

svn commit: r427021 - in /maven/plugins/trunk/maven-javadoc-plugin/src: main/java/org/apache/maven/plugin/javadoc/ site/ site/apt/ site/apt/examples/

Reply via email to