Author: oching
Date: Wed Jul 5 03:53:57 2006
New Revision: 419210
URL: http://svn.apache.org/viewvc?rev=419210&view=rev
Log:
PR: MJAVADOC-79
Fixed broken links in examples.
Fixed broken links in goals.
Applied codestyle in mvn javadoc:jar, etc.
Commented out FAQ page.
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternatedoclet.apt
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/excludepackagenames.apt
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/groupconfiguration.apt
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheetconfiguration.apt
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tagconfiguration.apt
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt
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/examples/aggregate.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt?rev=419210&r1=419209&r2=419210&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
Wed Jul 5 03:53:57 2006
@@ -29,7 +29,7 @@
When you execute javadoc from Project directory with aggregate set to "true",
a javadoc report will be created
in the target directory of Project wherein all the javadocs of Project's
modules are included. If aggregate is
- set to false, a javadoc report for Module1 will be generated in the target
directory of Module1, a javadoc
+ set to "false", a javadoc report for Module1 will be generated in the target
directory of Module1, a javadoc
report for Module2 will be generated in the target directory of Module2, and
a javadoc report for Module3 will be
generated in the target directory of Module3.
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternatedoclet.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternatedoclet.apt?rev=419210&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternatedoclet.apt
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternatedoclet.apt
Wed Jul 5 03:53:57 2006
@@ -0,0 +1,61 @@
+ ------
+ Using Alternate Doclet
+ ------
+ Vincent Siveton
+ Maria Odea Ching
+ ------
+ 20 June 2006
+ ------
+
+
+Using Alternate Doclet
+
+ To generate output from an alternate doclet in addition to the project
javadocs, add configuration
+ similar to the following to your POM:
+
++-----+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <reportSets>
+ <reportSet>
+ <id>uml</id>
+ <configuration>
+ <doclet>gr.spinellis.umlgraph.doclet.UmlGraph</doclet>
+ <docletArtifact>
+ <groupId>umlgraph</groupId>
+ <artifactId>UMLGraph</artifactId>
+ <version>4.2-SNAPSHOT</version>
+ </docletArtifact>
+ <additionalparam>-views</additionalparam>
+ <destDir>target/uml</destDir>
+ <show>private</show>
+ </configuration>
+ <reports>
+ <report>javadoc</report>
+ </reports>
+ </reportSet>
+ <reportSet>
+ <id>html</id>
+ <configuration>
+ <show>private</show>
+ </configuration>
+ <reports>
+ <report>javadoc</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ ...
+ </plugins>
+ </reporting>
+ ...
+</project>
++-----+
+
+ The first \<reportSet\> element with uml as id specifies that the a UML graph
(.dot file) will be generated and the second
+ \<reportSet\> element with html as its id specifies that the javadocs report
should be generated.
\ No newline at end of file
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/excludepackagenames.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/excludepackagenames.apt?rev=419210&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/excludepackagenames.apt
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/excludepackagenames.apt
Wed Jul 5 03:53:57 2006
@@ -0,0 +1,35 @@
+ ------
+ Excluding Packages
+ ------
+ Maria Odea Ching
+ ------
+ 20 June 2006
+ ------
+
+
+Excluding Packages
+
+ To exclude specific packages from the javadoc, make use of the
excludePackageNames parameter as shown below. The parameter
+ accepts wildcard (*) characters in its value. But the wildcards should either
be at the start of the package name or at the
+ end. If more than one package is to be excluded, each package name must be
separated either with a ':', ',' or ';'.
+
++-----+
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ ...
+
<excludePackageNames>*.internal:org.apache.maven.plugin.javadoc.exclude1.*:org.apache.maven.plugin.javadoc.exclude2</excludePackageNames>
+ ...
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
++-----+
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/groupconfiguration.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/groupconfiguration.apt?rev=419210&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/groupconfiguration.apt
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/groupconfiguration.apt
Wed Jul 5 03:53:57 2006
@@ -0,0 +1,43 @@
+ ------
+ Grouping Packages
+ ------
+ Vincent Siveton
+ Maria Odea Ching
+ ------
+ 20 June 2006
+ ------
+
+
+Grouping Packages
+
+ To set a grouping for different packages, set the configuration specified
below in your pom:
+
++-----+
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ ...
+ <groups>
+ <group>
+ <title>Core Packages</title>
+ <packages>org.apache.maven.plugin.javadoc.test1</packages>
+ </group>
+ <group>
+ <title>Extension Packages</title>
+ <packages>org.apache.maven.plugin.javadoc.test2</packages>
+ </group>
+ </groups>
+ ...
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
++-----+
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheetconfiguration.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheetconfiguration.apt?rev=419210&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheetconfiguration.apt
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheetconfiguration.apt
Wed Jul 5 03:53:57 2006
@@ -0,0 +1,37 @@
+ ------
+ Configuring Stylesheets
+ ------
+ Maria Odea Ching
+ ------
+ 20 June 2006
+ ------
+
+
+Configuring Stylesheets
+
+ If no custom stylesheet is specified in the stylesheetfile parameter, the
stylesheet parameter will indicate
+ which stylesheet will be used--the stylesheet included in the maven javadoc
plugin or the default stylesheet used by
+ the javadoc tool. "maven" indicates the maven javadoc plugin stylesheet,
while "java" indicates the default javadoc
+ tool stylesheet. It defaults to "java" if no value is indicated.
+
++-----+
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ ...
+ <stylesheet>maven</stylesheet>
+ ...
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
++-----+
+
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tagconfiguration.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tagconfiguration.apt?rev=419210&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tagconfiguration.apt
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tagconfiguration.apt
Wed Jul 5 03:53:57 2006
@@ -0,0 +1,41 @@
+ ------
+ Configuring Custom Javadoc Tags
+ ------
+ Vincent Siveton
+ Maria Odea Ching
+ ------
+ 20 June 2006
+ ------
+
+
+Configuring Custom Javadoc Tags
+
+ To set a custom tag used in the javadoc, the following configuration must be
set in the pom:
+
++-----+
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ ...
+ <tags>
+ <tag>
+ <name>todo</name>
+ <!-- Should be a combinaison of the letters Xaoptcmf -->
+ <placement>a</placement>
+ <head>To do something:</head>
+ </tag>
+ </tags>
+ ...
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
++-----+
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=419210&r1=419209&r2=419210&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 Wed Jul 5
03:53:57 2006
@@ -21,10 +21,10 @@
The Javadoc Plugin has two goals:
- * {{{index.html}javadoc:javadoc}} is used to generate the javadoc files for
the project. It uses the standard
+ * {{{plugin-info.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.
- * {{{index.html}javadoc:jar}} is used to create an archive file of the
generated javadocs. It is mostly used when
+ * {{{plugin-info.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
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=419210&r1=419209&r2=419210&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 Wed Jul 5
03:53:57 2006
@@ -1,5 +1,5 @@
------
- Configuring Javadoc Report
+ Usage
------
Vincent Siveton
Maria Odea Ching
@@ -37,7 +37,7 @@
</project>
+-----+
- When you execute 'mvn site', the javadocs will be generated and included in
the generated site. A link to the javadocs
+ When you execute <<<mvn site>>>, the javadocs will be generated and included
in the generated site. A link to the javadocs
will be added in the Project Reports.
* Generate Standalone Javadocs
@@ -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 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}}
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=419210&r1=419209&r2=419210&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml Wed Jul 5
03:53:57 2006
@@ -36,15 +36,15 @@
<menu name="Overview">
<item name="Overview" href="/index.html"/>
<item name="Usage" href="/usage.html"/>
- <item name="FAQs" href="/faq.html"/>
+ <!--item name="FAQs" href="/faq.html"/-->
</menu>
<menu name="Examples">
<item name="Aggregating Javadocs for Multi-Projects"
href="/examples/aggregate.html"/>
- <item name="Using Alternate Doclet"
href="/examples/alternateDoclet.html"/>
- <item name="Excluding Packages"
href="/examples/excludePackageNames.html"/>
- <item name="Grouping Packages" href="/examples/groupConfiguration.html"/>
- <item name="Configuring Stylesheets"
href="/examples/stylesheetConfiguration.html"/>
- <item name="Configuring Custom Javadoc Tags"
href="/examples/tagConfiguration.html"/>
+ <item name="Using Alternate Doclet"
href="/examples/alternatedoclet.html"/>
+ <item name="Excluding Packages"
href="/examples/excludepackagenames.html"/>
+ <item name="Grouping Packages" href="/examples/groupconfiguration.html"/>
+ <item name="Configuring Stylesheets"
href="/examples/stylesheetconfiguration.html"/>
+ <item name="Configuring Custom Javadoc Tags"
href="/examples/tagconfiguration.html"/>
</menu>
${reports}
</body>
