Author: oching
Date: Thu Jul 6 22:25:25 2006
New Revision: 419808
URL: http://svn.apache.org/viewvc?rev=419808&view=rev
Log:
Updated site.xml, index.apt and usage.apt.
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/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=419808&r1=419807&r2=419808&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 Thu Jul 6
22:25:25 2006
@@ -1,5 +1,5 @@
------
- Overview
+ Maven Javadoc Plugin: Overview
------
Maria Odea Ching
------
@@ -8,7 +8,7 @@
-Overview
+Maven 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}}.
@@ -21,20 +21,34 @@
The Javadoc Plugin has two goals:
- * {{{plugin-info.html}javadoc:javadoc}} is used to generate the javadoc
files for the project. It uses the standard
+ * {{{javadoc-mojo.html}javadoc:javadoc}} is used to generate the javadoc
files for the project. It uses the standard
Javadoc tool to generate the javadocs and supports the parameters used by
the tool.
- * {{{plugin-info.html}javadoc:jar}} is used to create an archive file of
the generated javadocs. It is mostly used when
+ * {{{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.
-* Usage
+* How To Use
Some basic instructions for configuring and using the mojos of the
<<<maven-javadoc-plugin>>> can be found in
the {{{usage.html}Usage guide}}.
* Examples
- Sample use-cases for the plugin are available under the Examples menu.
+ To provide you with better understanding on some usages of the Javadoc
plugin, you can take a look into the
+ following examples:
+
+ * {{{examples/aggregate.html}Aggregating Javadocs for Multi-Projects}}
+
+ * {{{examples/alternatedoclet.html}Using Alternate Doclet}}
+
+ * {{{examples/excludepackagenames.html}Excluding Packages}}
+
+ * {{{examples/groupconfiguration.html}Grouping Packages}}
+
+ * {{{examples/stylesheetconfiguration.html}Configuring Stylesheets}}
+
+ * {{{examples/tagconfiguration.html}Configuring Custom Javadoc Tags}}
+
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=419808&r1=419807&r2=419808&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 Thu Jul 6
22:25:25 2006
@@ -54,7 +54,7 @@
mvn javadoc:jar
+-----+
- For <<<mvn javadoc:jar>>>, the javadocs are generated first then it will be
archived in a jar file. The {{{plugin-info.html}javadoc:jar}}
+ 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
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=419808&r1=419807&r2=419808&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml Thu Jul 6
22:25:25 2006
@@ -34,8 +34,8 @@
</links>
<menu name="Overview">
- <item name="Overview" href="index.html"/>
- <item name="Usage" href="usage.html"/>
+ <item name="Introduction" href="index.html"/>
+ <item name="How To Use" href="usage.html"/>
<item name="FAQs" href="faq.html"/>
</menu>
<menu name="Examples">
