You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2008/07/31 13:46:32 UTC
svn commit: r681343 - in /maven/plugins/trunk/maven-javadoc-plugin/src/site:
apt/ apt/examples/ fml/
Author: vsiveton
Date: Thu Jul 31 04:46:31 2008
New Revision: 681343
URL: http://svn.apache.org/viewvc?rev=681343&view=rev
Log:
o improved doc
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-doclet.apt
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml
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=681343&r1=681342&r2=681343&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 Thu Jul 31 04:46:31 2008
@@ -3,7 +3,7 @@
------
Maria Odea Ching
------
- June 2008
+ 2008-07-31
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -26,26 +26,26 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-Aggregating Javadocs for Multi-Projects
+Aggregating Javadocs For Multi-Projects
For example, consider the following directory structure:
+-----+
Project
-|-- pom.xml
-|-- Module1
-| `-- pom.xml
-|-- Module2
-| `-- pom.xml
-`-- Module3
+ |-- pom.xml
+ |-- Module1
+ | `-- pom.xml
+ |-- Module2
+ | `-- pom.xml
+ `-- Module3
`-- pom.xml
+-----+
-* Using the \<aggregate\> parameter
+* Using The \<aggregate\> Parameter
- The \<aggregate\> parameter can be used to generate javadocs for multi-module projects. It gives the option to
+ The \<aggregate/\> parameter can be used to generate javadocs for multi-module projects. It gives the option to
generate one javadoc report for the entire project (all modules) or generate one javadoc report for each module.
When you execute javadoc:javadoc from Project directory with aggregate set to <<true>>, a javadoc report will be created
@@ -75,8 +75,8 @@
</project>
+-----+
-* Using the \<aggregate\> goal
+* Using The \<aggregate\> Goal
- The \<aggregate\> parameter doesn't include generate source directories defined using the
+ The \<aggregate/\> parameter doesn't include generate source directories defined using the
{{{http://mojo.codehaus.org/build-helper-maven-plugin/add-source-mojo.html}build-helper:add-source}}. In this case, you need
- to use the <<<aggregate>>> goal and <<<test-aggregate>>> goals.
\ No newline at end of file
+ to use the <<<aggregate>>> goal and <<<test-aggregate>>> goals.
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-doclet.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-doclet.apt?rev=681343&r1=681342&r2=681343&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-doclet.apt (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-doclet.apt Thu Jul 31 04:46:31 2008
@@ -4,7 +4,7 @@
Vincent Siveton
Maria Odea Ching
------
- September 2006
+ 2208-07-31
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -67,15 +67,15 @@
* \<additionalparam/\> is used to set additional parameters on the command line, specifically
for doclet options.
- * if you need more artifacts in the docletpath, you could use \<docletArtifacts/\>.
+ * If you need more artifacts in the docletpath, you could use \<docletArtifacts/\>.
After executing <<<mvn site>>>, you will see that a UML graph (.dot file) will be generated in the
destination directory.
- <<Note about UmlGraph>>: You must have the Graphviz binary on your PATH, or the images will not be generated.
+ <<Note about UmlGraph>>: You must have the Graphviz binary in your PATH, or the images will not be generated.
For more information about Graphviz, please refer to {{http://www.graphviz.org/}}.
-Using Alternate Doclet in Addition to the Javadoc Doclet
+Using Alternate Doclet In Addition To The Javadoc Doclet
To generate output from an alternate doclet in addition to the normal HTML Javadoc doclet, add configuration
similar to the following to your POM.
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt?rev=681343&r1=681342&r2=681343&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt Thu Jul 31 04:46:31 2008
@@ -4,7 +4,7 @@
Vincent Siveton
Maria Odea Ching
------
- June 2006
+ 2008-07-31
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -29,7 +29,7 @@
Grouping Packages
- To set a grouping for different packages, use the \<groups\> configuration in your pom:
+ To set a grouping for different packages, use the \<groups/\> configuration in your pom:
+-----+
<project>
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt?rev=681343&r1=681342&r2=681343&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt Thu Jul 31 04:46:31 2008
@@ -3,7 +3,7 @@
------
Vincent Siveton
------
- May 2007
+ 2008-07-31
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -54,7 +54,7 @@
`-- app.png
+-----+
-* Overview comment files: <overview.html>
+* Overview Comment File: <overview.html>
These contain comments about the set of packages. The <overview.html> is a general documentation that applies to
the entire application or set of packages.
@@ -100,7 +100,7 @@
</project>
+-----+
-* Package comment files: <package.html>
+* Package Comment File: <package.html>
These contain package comments. The <package.html> is a brief summary of each packages in the list of all packages.
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt?rev=681343&r1=681342&r2=681343&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt Thu Jul 31 04:46:31 2008
@@ -3,7 +3,7 @@
------
Maria Odea Ching
------
- June 2006
+ 2008-07-31
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,10 +28,10 @@
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. The default is <<java>> if not specified.
+ 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>> value indicates the maven javadoc plugin stylesheet, while <<java>> value indicates the
+ default javadoc tool stylesheet. The default is <<java>> value if not specified.
+-----+
<project>
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt?rev=681343&r1=681342&r2=681343&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt Thu Jul 31 04:46:31 2008
@@ -4,7 +4,7 @@
Vincent Siveton
Maria Odea Ching
------
- June 2006
+ 2008-07-31
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -29,7 +29,7 @@
Configuring Custom Javadoc Tags
- You can configure any custom tags used in your javadoc via the \<tags\> element:
+ You can configure any custom tags used in your javadoc via the \<tags/\> element:
+-----+
<project>
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=681343&r1=681342&r2=681343&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 31 04:46:31 2008
@@ -4,7 +4,7 @@
Vincent Siveton
Maria Odea Ching
------
- 27 June 2006
+ 2008-07-31
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -33,7 +33,7 @@
The Javadoc Plugin generates javadocs using the Javadoc tool. The following examples describe the basic usage of the
Plugin.
-* Generate Javadocs As Part of Project Reports
+* Generate Javadocs As Part Of Project Reports
To generate javadocs as part of the site generation, you must configure the following in the \<reporting\> section of your pom:
@@ -77,7 +77,5 @@
The Javadoc Plugin supports a large number of configuration parameters. Each configuration parameter turns into
a tag name.
- Please see the {{{javadoc-mojo.html}javadoc:javadoc}} goal documentation for a listing of these parameters. Most
- of these parameters are passed directly to the javadoc tool itself.
-
- More info on the Javadoc tool can be found {{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html}here}}.
+ Please see the {{{./apidocs/org/apache/maven/plugin/javadoc/package-summary.html}Javadoc Package Summary}}
+ for a listing of these parameters. Most of these parameters are passed directly to the Javadoc tool itself.
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=681343&r1=681342&r2=681343&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 Thu Jul 31 04:46:31 2008
@@ -27,8 +27,8 @@
<p>
All options provided by Sun on the Javadoc homepages are wrapped in the Maven Javadoc Plugin. This
plugin supports Javadoc 1.4, 1.5 and 6.0 options. Refer you to the
- <a href="./apidocs/org/apache/maven/plugin/javadoc/package-summary.html">Package Summary</a> for
- more information.
+ <a href="./apidocs/org/apache/maven/plugin/javadoc/package-summary.html">Javadoc Package Summary</a>
+ for more information.
</p>
</answer>
</faq>
@@ -75,8 +75,10 @@
when the Javadoc Plugin ended.
</p>
<p>
- To preserve them, just add <debug>true<debug> in your Javadoc Plugin configuration. In this case,
- an additional script file will be created.
+ To preserve them, just add <debug>true</debug> in your Javadoc Plugin configuration or just call
+ <code>mvn javadoc:javadoc -Ddebug=true</code> or <code>mvn javadoc:javadoc -X</code>.
+ In this case, an additional script file (javadoc.bat (or .sh) will be created in the <code>apidocs</code>
+ directory.
</p>
</answer>
</faq>
@@ -182,8 +184,8 @@
</p>
</answer>
</faq>
- <faq id="How to deploy javadoc jar">
- <question>How to deploy javadoc jar?</question>
+ <faq id="How to deploy Javadoc jar file">
+ <question>How to deploy Javadoc jar file?</question>
<answer>
<p>
Basically, you need to call <i>mvn clean javadoc:jar deploy</i>. If you want to include the javadoc jar
@@ -211,6 +213,7 @@
</plugins>
</build>
</profile>
+ ...
</profiles>
...
</project></source>
@@ -255,8 +258,8 @@
</p>
</answer>
</faq>
- <faq id="On Sun JDK, why javadoc:javadoc goal blows up due to an IllegalArgumentException in sun.net.www.ParseUtil.decode()">
- <question>On Sun JDK, why <i>javadoc:javadoc</i> goal blows up due to an IllegalArgumentException in <i>sun.net.www.ParseUtil.decode()</i>?</question>
+ <faq id="On Windows with Sun JDK, why javadoc:javadoc goal blows up due to an IllegalArgumentException in sun.net.www.ParseUtil.decode()">
+ <question>On Windows with Sun JDK, why <i>javadoc:javadoc</i> goal blows up due to an IllegalArgumentException in <i>sun.net.www.ParseUtil.decode()</i>?</question>
<answer>
<p>
You are on Windows XP with Sun JDK 5 or JDK 6 freshly installed, and when you run <i>mvn javadoc:javadoc</i>,
@@ -349,11 +352,13 @@
<p>
Your <i>CLASSPATH</i> environement variable is probably corrupted, i.e. something like:
<source>CLASSPATH=.;C:\Java\jdk1.6.0_03\jre\lib\ext\QTJava.zip;%JAVAHOME%</source>
+ with <code>%JAVAHOME%</code> not a valid environment variable.
</p>
<p>
To resolve it, just reset the <i>CLASSPATH</i> environement variable, i.e.: <source>set CLASSPATH=</source>
or set a new <i>CLASSPATH</i> environement variable, i.e.:
<source>set CLASSPATH=C:\Java\jdk1.6.0_03\jre\lib\ext\QTJava.zip</source>
+ or fix the wrong environment variable.
</p>
<p>
Refer you to