maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From och...@apache.org
Subject svn commit: r419833 - in /maven/plugins/trunk/maven-javadoc-plugin/src/site: apt/index.apt apt/usage.apt fml/faq.fml site.xml
Date Fri, 07 Jul 2006 07:46:21 GMT
Author: oching
Date: Fri Jul  7 00:46:20 2006
New Revision: 419833

URL: http://svn.apache.org/viewvc?rev=419833&view=rev
Log:
Updated usage.apt and faq. Also updated site.xml.

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

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?rev=419833&r1=419832&r2=419833&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt Fri Jul  7 00:46:20 2006
@@ -1,5 +1,5 @@
  ------
- Maven Javadoc Plugin: Overview
+ Introduction
  ------
  Maria Odea Ching
  ------
@@ -8,7 +8,7 @@
 
 
 
-Maven Javadoc Plugin
+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}}.
@@ -27,10 +27,9 @@
    * {{{jar-mojo.html}javadoc:jar}} is used to create an archive file of the generated javadocs.
It is mostly used when
      releasing to publish to the repository.
 
-* How To Use
+* Usage
 
-   Some basic instructions for configuring and using the mojos of the <<<maven-javadoc-plugin>>>
can be found in
-   the {{{usage.html}Usage guide}}.
+   Some basic instructions for configuring and using the mojos of the <<<maven-javadoc-plugin>>>
can be found {{{usage.html}here}}.
 
 * Examples
 

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=419833&r1=419832&r2=419833&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 Fri Jul  7 00:46:20 2006
@@ -1,5 +1,5 @@
  ------
- Usage
+ Maven 2 Javadoc Plugin: Usage
  ------
  Vincent Siveton
  Maria Odea Ching
@@ -7,7 +7,7 @@
  27 June 2006
  ------
 
-How To Use
+Usage
 
  The Javadoc Plugin generates javadocs using the Javadoc tool. Iterated below are the different
goals and configuration for
  generating them using the plugin.
@@ -57,8 +57,8 @@
  For <<<mvn javadoc:jar>>>, the javadocs are generated first then it will
be archived in a jar file. The {{{jar-mojo.html}javadoc:jar}}
  goal is run by default and is mostly used when releasing to publish to the repository.
 
- To set the configuration of the Javadoc plugin when executing these commands, you must configure
it in the
- \<build\> section of your pom file as shown below:
+ You should only configure the plugin in the \<build\> section of your pom file, as
shown below, if and only if the configuration is
+ different to the configuration on the site or the report is not included on the site at
all.
 
 +-----+
 <project>

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?rev=419833&r1=419832&r2=419833&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml Fri Jul  7 00:46:20 2006
@@ -3,7 +3,7 @@
   <part id="General">
     <faq id="1">
       <question>In which part of the pom.xml does the Javadoc plugin should be configured?</question>
-      <answer><p>You can configura the Javadoc plugin in the <i>reporting</i>
section of your pom.xml if you want to include it in the site generation process (e.g. mvn
site). Otherwise if you want to explicitly generate javadocs, you can configure it in the
<i>build</i> section of your pom.xml.</p></answer>
+      <answer><p>You can configura the Javadoc plugin in the <i>reporting</i>
section of your pom.xml if you want to include it in the site generation process (e.g. mvn
site). You can also configure it in the <i>build</i> section of your pom if the
configuration is different on the site or the report is not included on the site at all.</p></answer>
     </faq>    
   </part>
 </faqs>

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=419833&r1=419832&r2=419833&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml Fri Jul  7 00:46:20 2006
@@ -35,7 +35,7 @@
 
     <menu name="Overview">
       <item name="Introduction" href="index.html"/>
-      <item name="How To Use" href="usage.html"/>
+      <item name="Usage" href="usage.html"/>
       <item name="FAQs" href="faq.html"/>
     </menu>
     <menu name="Examples">



Mime
View raw message