svn commit: r535533 - in /maven/plugins/trunk/maven-javadoc-plugin/src: main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java site/fml/faq.fml

[vsiveton]

Author: vsiveton
Date: Sat May  5 07:39:46 2007
New Revision: 535533

URL: http://svn.apache.org/viewvc?view=rev&rev=535533
Log:
MJAVADOC-121: Add a new parameter to handle additional -J options

o added additionalJOption parameter
o updated documentation

Modified:
    
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
    maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml

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?view=diff&rev=535533&r1=535532&r2=535533
==============================================================================
--- 
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
 Sat May  5 07:39:46 2007
@@ -139,7 +139,7 @@
     private String javadocDirectory;
 
     /**
-     * Set an additional parameter(s) on the command line.  This value should 
include quotes as necessary for
+     * Set an additional parameter(s) on the command line. This value should 
include quotes as necessary for
      * parameters that include spaces.
      *
      * @parameter expression="${additionalparam}"
@@ -147,6 +147,18 @@
     private String additionalparam;
 
     /**
+     * Set an additional J option(s) on the command line.
+     * Example:
+     * <pre>
+     * &lt;additionalJOption&gt;-J-Xss128m&lt;/additionalJOption&gt;
+     * </pre>
+     * See <a 
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#J";>Jflag</a>.
+     *
+     * @parameter expression="${additionalJOption}"
+     */
+    private String additionalJOption;
+
+    /**
      * Used for resolving artifacts
      *
      * @component
@@ -1004,6 +1016,11 @@
         addMemoryArg( cmd, "-Xmx", this.maxmemory );
 
         addMemoryArg( cmd, "-Xms", this.minmemory );
+
+        if ( StringUtils.isNotEmpty( additionalJOption ) )
+        {
+            cmd.createArgument().setValue( additionalJOption );
+        }
 
         List arguments = new ArrayList();
 

Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml?view=diff&rev=535533&r1=535532&r2=535533
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml Sat May  5 
07:39:46 2007
@@ -61,5 +61,28 @@
         </p>
       </answer>
     </faq>
+    <faq id="How to add additional Javadoc parameters">
+      <question>How to add additional Javadoc parameters?</question>
+      <answer>
+        <p>
+          You could need to add more Javadoc parameters to be process by the 
Javadoc Tool (i.e. for doclet).
+        </p>
+        <p>
+          For this, you should use the <i>&lt;additionalparam/&gt;</i> 
parameter in your Javadoc Plugin configuration.
+        </p>
+      </answer>
+    </faq>
+    <faq id="How to add additional Javadoc options">
+      <question>How to add additional Javadoc options?</question>
+      <answer>
+        <p>
+          You could need to add more J options (i.e. runtime system java 
options that runs Javadoc tool) to be process
+          by the Javadoc Tool (i.e. -J-Xss).
+        </p>
+        <p>
+          For this, you should use the <i>&lt;additionalJOption/&gt;</i> 
parameter in your Javadoc Plugin configuration.
+        </p>
+      </answer>
+    </faq>
   </part>
 </faqs>