maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vsive...@apache.org
Subject svn commit: r441959 - in /maven/plugins/trunk/maven-javadoc-plugin/src/site: apt/index.apt fml/faq.fml
Date Sun, 10 Sep 2006 15:00:54 GMT
Author: vsiveton
Date: Sun Sep 10 08:00:53 2006
New Revision: 441959

URL: http://svn.apache.org/viewvc?view=rev&rev=441959
Log:
o improved documentation (introduction and faq)

Modified:
    maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt
    maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml

Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt?view=diff&rev=441959&r1=441958&r2=441959
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt Sun Sep 10 08:00:53 2006
@@ -26,11 +26,22 @@
 
 Maven 2 Javadoc Plugin
 
- The Javadoc Plugin uses the Javadoc tool to generate javadocs for the specified project.
For more information about the
- standard Javadoc tool, see {{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html}here}}.
+ The Javadoc Plugin uses the Javadoc tool to generate javadocs for the specified project.
+ For more information about the standard Javadoc tool, please refer to
+ {{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html}Reference Guide}}.
 
  The Javadoc Plugin gets the parameter values that will be used from the plugin configuration
specified in the pom.
+ To hold all javadoc arguments, packages or files, the Javadoc Plugin generates
+ {{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#argumentfiles}argument
files}}
+ and calls the Javadoc tool as follow:
+
++-----+
+#${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
+    @options @packages | @argfile
++-----+
+
  When no configuration values are set, the plugin sets default values instead and then executes
the Javadoc tool.
+
  You can also use the plugin to package the generated javadocs into a jar file for distribution.
 
 * Goals Overview

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=441959&r1=441958&r2=441959
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml Sun Sep 10 08:00:53 2006
@@ -18,16 +18,16 @@
 
 <faqs id="FAQ" title="Frequently Asked Questions">
   <part id="General">
-    <faq id="Where in the pom.xml do I configure the Javadoc plugin?">
-      <question>Where in the pom.xml do I configure the Javadoc plugin?</question>
+    <faq id="Where in the pom.xml do I configure the Javadoc Plugin">
+      <question>Where in the pom.xml do I configure the Javadoc Plugin?</question>
       <answer>
         <p>
-          Like all other site report plugins, the Javadoc plugin goes in the
-          <i>reporting</i> section of your pom.xml.
+          Like all other site report plugins, the Javadoc Plugin goes in the
+          <i>&lt;reporting/&gt;</i> section of your pom.xml.
         </p>
       </answer>
     </faq>
-    <faq id="Where do I put javadoc resources like package.html?">
+    <faq id="Where do I put javadoc resources like package.html">
       <question>Where do I put Javadoc resources like HTML files or images?</question>
       <answer>
         <p>
@@ -50,6 +50,25 @@
           |...
             `-- package.html
         </source>
+      </answer>
+    </faq>
+    <faq id="How to know exactly the Javadoc command line">
+      <question>How to know exactly the Javadoc command line?</question>
+      <answer>
+        <p>
+          The Javadoc Plugin calls the Javadoc tool with
+          <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#argumentfiles">argument
files</a>,
+          i.e. files called 'options', 'packages' and 'argfile' (or 'files' with Jdk &lt;
1.4):
+          <source>${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh)
\
+          @options @packages | @argfile</source>
+        </p>
+        <p>
+          These argument files are generated at runtime depending the Javadoc Plugin configuration
and are deleted
+          when the Javadoc Plugin ended.
+        </p>
+        <p>
+          To preserve them, just add &lt;debug&gt;true&lt;debug&gt; in your
Javadoc Plugin configuration.
+        </p>
       </answer>
     </faq>
   </part>



Mime
View raw message