You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/08/19 19:31:48 UTC
svn commit: r829394 [17/31] - in
/websites/production/maventest/content/plugins/maven-javadoc-plugin-latest:
./ apidocs/ apidocs/org/apache/maven/plugin/javadoc/
apidocs/org/apache/maven/plugin/javadoc/class-use/
apidocs/org/apache/maven/plugin/javadoc...
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/faq.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/faq.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/faq.html Sun Aug 19 17:31:42 2012
@@ -73,8 +73,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -314,10 +314,10 @@
<li><a href="#How_to_remove_test_Javadocs_report">How to remove test Javadocs report?</a></li>
<li><a href="#How_to_deploy_Javadoc_jar_file">How to deploy Javadoc jar file?</a></li>
<li><a href="#How_to_include_additional_source_code_directories_in_aggregate_mode">How to include additional source code directories in aggregate mode?</a></li>
-<li><a href="#How_to_use_links_option_in_Standard_Doclet">How to use links option in Standard Doclet?</a></li>
+<li><a href="#How_to_use_links_option_in_Standard_Doclet">How to use <i><a href="./javadoc-mojo.html#links"><links/></a></i> option in Standard Doclet?</a></li>
+<li><a href="#How_to_add_cross_reference_link_to_internal-external_projects">How to add cross reference link to internal-external projects?</a></li>
<li><a href="#On_Windows_with_Sun_JDK_why_javadoc:javadoc_goal_blows_up_due_to_an_IllegalArgumentException_in_sun.net.www.ParseUtil.decode">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>?</a></li>
<li><a href="#What_are_the_values_of_encoding_docencoding_and_charset_parameters">What are the values of <code>encoding</code>, <code>docencoding</code> and <code>charset</code> parameters?</a></li>
-<li><a href="#How_to_add_cross_reference_link_to_internal-external_projects">How to add cross reference link to internal-external projects?</a></li>
</ol>
</div>
<dl><dt><a name="What_are_the_Javadoc_options_supported_by_the_Maven_Javadoc_Plugin">What are the Javadoc options supported by the Maven Javadoc Plugin?</a></dt>
@@ -326,20 +326,26 @@
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">Javadoc Package Summary</a>
- for more information.
+ for more information and to the <a href="./javadoc-mojo.html">Javadoc Plugin Documentation</a>.
</p>
<table border="0"><tr><td align="right"><a href="#top">[top]</a></td></tr></table><hr />
</dd>
<dt><a name="Where_in_the_pom.xml_do_I_configure_the_Javadoc_Plugin">Where in the pom.xml do I configure the Javadoc Plugin?</a></dt>
<dd>
<p>
- Like all other site report plugins, the Javadoc Plugin goes in the <i><reporting/></i> section
+ Like all other reporting plugins, the Javadoc Plugin goes in the <i><reporting/></i> section
of your pom.xml. In this case, you will need to call <code>mvn site</code> to run reports.
</p>
<p>
- You could also configure it in the <plugins/> or <pluginsManagement/> in <build/> tag
- of your pom.xml. In this case, you will need to call <code>mvn javadoc:javadoc</code> to run the main
- report.
+ You could also configure it in the <i><plugins/></i> or <i><pluginsManagement/></i> in
+ <i><build/></i> tag of your pom.xml. In this case, you will need to call
+ <code>mvn javadoc:javadoc</code> to run the main report.
+ </p>
+ <p>
+ <b>IMPORTANT NOTE</b>: using <i><reporting/></i> or <i><build/></i> elements have not the same
+ behavior, refer to
+ <a href="http://maven.apache.org/guides/mini/guide-configuring-plugins.html#Using_the_reporting_Tag_VS_build_Tag">Using the <reporting/> Tag VS <build/> Tag</a>
+ part for more information.
</p>
<table border="0"><tr><td align="right"><a href="#top">[top]</a></td></tr></table><hr />
</dd>
@@ -426,11 +432,11 @@ ${project.reporting.outputDirectory}/api
<minmemory>128m</minmemory>
<maxmemory>1g</maxmemory>
...
- </configuration>
- </plugin>
- </plugins>
+ </configuration>
+ </plugin>
+ </plugins>
...
- </reporting>
+ </reporting>
...
</project></pre>
</div>
@@ -446,24 +452,54 @@ ${project.reporting.outputDirectory}/api
<dt><a name="How_to_add_proxy_support">How to add proxy support?</a></dt>
<dd>
<p>
- To specify a proxy in the Javadoc tool, you need to configure an active proxy in your <i>settings.xml</i>. Read the
- <a href="http://maven.apache.org/guides/mini/guide-proxies.html">Configuring a proxy</a> guide for more information.
- </p>
- <p>
- The Javadoc Plugin calls the Javadoc tool with networking J options, i.e.:
+ To specify a proxy in the Javadoc tool, you need to configure an active proxy in your
+ <i>${user.home}/.m2/settings.xml</i>, similar to:
+ <div class="source"><pre>
+<settings>
+ ...
+ <proxies>
+ <proxy>
+ <active>true</active>
+ <protocol>http</protocol>
+ <host>proxy.somewhere.com</host>
+ <port>3128</port>
+ <username>foo</username>
+ <password>bar</password>
+ <nonProxyHosts>java.sun.com|*.somewhere.com</nonProxyHosts>
+ </proxy>
+ </proxies>
+ ...
+</settings>
+</pre>
+</div>
+
+ With this, the Javadoc tool will be called with networking J options, i.e.:
<div class="source"><pre>
${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
-J-Dhttp.proxySet=true \
- -J-Dhttp.proxyHost=http://localhost \
- -J-Dhttp.proxyPort=80 \
- -J-Dhttp.nonProxyHosts="www.google.com|*.somewhere.com" \
- -J-Dhttp.proxyUser="toto" \
- -J-Dhttp.proxyPassword="toto" \
+ -J-Dhttp.proxyHost=proxy.somewhere.com \
+ -J-Dhttp.proxyPort=3128 \
+ -J-Dhttp.nonProxyHosts="java.sun.com|*.somewhere.com" \
+ -J-Dhttp.proxyUser="foo" \
+ -J-Dhttp.proxyPassword="bar" \
@options \
@packages | @argfile</pre>
</div>
</p>
+ <p>
+ <b>Note</b>: If your proxy needs more JVM
+ <a href="http://java.sun.com/j2se/1.4.2/docs/guide/net/properties.html">networking properties</a>
+ (like NTLM), you could always add JVM options using the <i><additionalJOption/></i> parameter
+ in your Javadoc Plugin configuration, i.e.:
+ <div class="source"><pre>
+<configuration>
+ <additionalJOption>-J-Dhttp.auth.ntlm.domain=MYDOMAIN</additionalJOption>
+ ...
+</configuration></pre>
+</div>
+
+ </p>
<table border="0"><tr><td align="right"><a href="#top">[top]</a></td></tr></table><hr />
</dd>
<dt><a name="How_to_have_less_output">How to have less output?</a></dt>
@@ -502,15 +538,15 @@ ${project.reporting.outputDirectory}/api
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
...
- </profiles>
+ </profiles>
...
</project></pre>
</div>
@@ -544,18 +580,26 @@ mvn deploy:deploy-file \
</p>
<table border="0"><tr><td align="right"><a href="#top">[top]</a></td></tr></table><hr />
</dd>
-<dt><a name="How_to_use_links_option_in_Standard_Doclet">How to use links option in Standard Doclet?</a></dt>
+<dt><a name="How_to_use_links_option_in_Standard_Doclet">How to use <i><a href="./javadoc-mojo.html#links"><links/></a></i> option in Standard Doclet?</a></dt>
<dd>
<p>
- You need to configure the <i><links/></i> parameter. Also, you need to correctly write references in
- your Javadoc, i.e.:
+ You need to configure the <i><a href="./javadoc-mojo.html#links"><links/></a></i> parameter. Also, you
+ should correctly write references in your Javadoc, i.e.:
</p>
<ul>
<li><code>@see MyMojo</code> or <code>{@link MyMojo}</code> will <b>NOT work</b>.</li>
- <li><code>@see com.mycompany.plugin.myplugin.MyMojo</code> or <code>{@link com.mycompany.myplugin.MyMojo}</code> will <b>work</b>.</li>
+ <li><code>@see com.mycompany.plugin.myplugin.MyMojo</code> or <code>{@link com.mycompany.myplugin.MyMojo}</code>
+ will <b>work</b>.</li>
</ul>
<table border="0"><tr><td align="right"><a href="#top">[top]</a></td></tr></table><hr />
</dd>
+<dt><a name="How_to_add_cross_reference_link_to_internal-external_projects">How to add cross reference link to internal-external projects?</a></dt>
+<dd>
+ <p>
+ Please refer to <a href="./examples/links-configuration.html">Links configuration page</a>.
+ </p>
+ <table border="0"><tr><td align="right"><a href="#top">[top]</a></td></tr></table><hr />
+</dd>
<dt><a name="On_Windows_with_Sun_JDK_why_javadoc:javadoc_goal_blows_up_due_to_an_IllegalArgumentException_in_sun.net.www.ParseUtil.decode">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>?</a></dt>
<dd>
<p>
@@ -571,7 +615,7 @@ mvn deploy:deploy-file \
[INFO] ------------------------------------------------------------------------
[INFO] An error has occurred in JavaDocs report generation:Exit code: 1 - java.lang.IllegalArgumentException
at sun.net.www.ParseUtil.decode(ParseUtil.java:189)
- at sun.misc.URLClassPath$FileLoader.<init>(URLClassPath.java:953)
+ at sun.misc.URLClassPath$FileLoader.&lt;init&gt;(URLClassPath.java:953)
at sun.misc.URLClassPath$3.run(URLClassPath.java:326)
at java.security.AccessController.doPrivileged(Native Method)
at sun.misc.URLClassPath.getLoader(URLClassPath.java:320)
@@ -701,13 +745,6 @@ mvn deploy:deploy-file \
<dt><code>charset</code></dt>
<dd>Value of <code>docencoding</code> parameter if not specified.</dd>
</dl>
- <table border="0"><tr><td align="right"><a href="#top">[top]</a></td></tr></table><hr />
-</dd>
-<dt><a name="How_to_add_cross_reference_link_to_internal-external_projects">How to add cross reference link to internal-external projects?</a></dt>
-<dd>
- <p>
- Please refer to <a href="./examples/links-configuration.html">Links configuration page</a>.
- </p>
<table border="0"><tr><td align="right"><a href="#top">[top]</a></td></tr></table></dd>
</dl>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/fix-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/fix-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/fix-mojo.html Sun Aug 19 17:31:42 2012
@@ -73,8 +73,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -303,7 +303,7 @@
<div id="contentBox">
<div class="section"><h2><a name="javadoc:fix"></a>javadoc:fix</h2>
<p><strong>Full name</strong>:</p>
-<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6:fix</p>
+<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6.1:fix</p>
<p><strong>Description</strong>:</p>
<div>Fix Javadoc documentation and tags for the <code>Java code</code>
for the project. See <a href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#wheretags" class="externalLink">
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/help-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/help-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/help-mojo.html Sun Aug 19 17:31:42 2012
@@ -73,8 +73,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -303,18 +303,17 @@
<div id="contentBox">
<div class="section"><h2><a name="javadoc:help"></a>javadoc:help</h2>
<p><strong>Full name</strong>:</p>
-<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6:help</p>
+<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6.1:help</p>
<p><strong>Description</strong>:</p>
<div>Display help information on maven-javadoc-plugin.<br />
Call
<pre>
- mvn javadoc:help -Ddetail=true -Dgoal=<goal-name>
+ mvn javadoc:help -Ddetail=true -Dgoal=<goal-name>
</pre>
to display parameter details.</div><p><strong>Attributes</strong>:</p>
-<ul></ul>
<div class="section"><h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
Added: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/images/inherit.gif
==============================================================================
Binary file - no diff available.
Propchange: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/images/inherit.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/images/inherit.psd
==============================================================================
Binary file - no diff available.
Propchange: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/images/inherit.psd
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/index.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/index.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/index.html Sun Aug 19 17:31:42 2012
@@ -75,8 +75,8 @@ Vincent Siveton" />
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -360,40 +360,40 @@ Vincent Siveton" />
<p>You can also use the plugin to package the generated javadocs into a jar file for distribution.</p>
<div class="section"><h3>Goals Overview</h3>
<p>The Javadoc Plugin has ten goals:</p>
-<ul><li><a href="javadoc-mojo.html">javadoc:javadoc</a> generates the Javadoc files for the project. It executes the standard Javadoc tool and supports the parameters used by the tool.</li>
-<li><a href="test-javadoc-mojo.html">javadoc:test-javadoc</a> generates the test Javadoc files for the project. It executes the standard Javadoc tool and supports the parameters used by the tool.</li>
-<li><a href="aggregate-mojo.html">javadoc:aggregate</a> generates the Javadoc files for an aggregator project. It executes the standard Javadoc tool and supports the parameters used by the tool.</li>
-<li><a href="test-aggregate-mojo.html">javadoc:test-aggregate</a> generates the test Javadoc files for an aggregator project. It executes the standard Javadoc tool and supports the parameters used by the tool.</li>
-<li><a href="jar-mojo.html">javadoc:jar</a> creates an archive file of the generated Javadocs. It is used during the release process to create the Javadoc artifact for the project's release. This artifact is uploaded to the remote repository along with the project's compiled binary and source archive.</li>
-<li><a href="test-jar-mojo.html">javadoc:test-jar</a> creates an archive file of the generated Test Javadocs.</li>
-<li><a href="aggregate-jar-mojo.html">javadoc:aggregate-jar</a> creates an archive file of the generated Javadocs for an aggregator project.</li>
-<li><a href="test-aggregate-jar-mojo.html">javadoc:test-aggregate-jar</a> creates an archive file of the generated Test Javadocs for an aggregator project.</li>
-<li><a href="fix-mojo.html">javadoc:fix</a> is an interactive goal which fixes the Javadoc documentation and tags for the Java files.</li>
-<li><a href="test-fix-mojo.html">javadoc:test-fix</a> is an interactive goal which fixes the Javadoc documentation and tags for the test Java files.</li>
+<ul><li><a href="./javadoc-mojo.html">javadoc:javadoc</a> generates the Javadoc files for the project. It executes the standard Javadoc tool and supports the parameters used by the tool.</li>
+<li><a href="./test-javadoc-mojo.html">javadoc:test-javadoc</a> generates the test Javadoc files for the project. It executes the standard Javadoc tool and supports the parameters used by the tool.</li>
+<li><a href="./aggregate-mojo.html">javadoc:aggregate</a> generates the Javadoc files for an aggregator project. It executes the standard Javadoc tool and supports the parameters used by the tool.</li>
+<li><a href="./test-aggregate-mojo.html">javadoc:test-aggregate</a> generates the test Javadoc files for an aggregator project. It executes the standard Javadoc tool and supports the parameters used by the tool.</li>
+<li><a href="./jar-mojo.html">javadoc:jar</a> creates an archive file of the generated Javadocs. It is used during the release process to create the Javadoc artifact for the project's release. This artifact is uploaded to the remote repository along with the project's compiled binary and source archive.</li>
+<li><a href="./test-jar-mojo.html">javadoc:test-jar</a> creates an archive file of the generated Test Javadocs.</li>
+<li><a href="./aggregate-jar-mojo.html">javadoc:aggregate-jar</a> creates an archive file of the generated Javadocs for an aggregator project.</li>
+<li><a href="./test-aggregate-jar-mojo.html">javadoc:test-aggregate-jar</a> creates an archive file of the generated Test Javadocs for an aggregator project.</li>
+<li><a href="./fix-mojo.html">javadoc:fix</a> is an interactive goal which fixes the Javadoc documentation and tags for the Java files.</li>
+<li><a href="./test-fix-mojo.html">javadoc:test-fix</a> is an interactive goal which fixes the Javadoc documentation and tags for the test Java files.</li>
</ul>
</div>
<div class="section"><h3>Usage</h3>
-<p>General instructions on how to use the Javadoc Plugin can be found on the <a href="usage.html">usage page</a>. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the <a href="http://docs.codehaus.org/display/MAVENUSER/Javadoc+Plugin" class="externalLink">plugin's wiki page</a>.</p>
-<p>In case you still have questions regarding the plugin's usage, please have a look at the <a href="faq.html">FAQ</a> and feel free to contact the <a href="mail-lists.html">user mailing list</a>. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the <a href="mail-lists.html">mail archive</a>.</p>
-<p>If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our <a href="issue-tracking.html">issue tracker</a>. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our <a href="source-repository.html">source repository</a> and will find supplementary information in the <a href="http://maven.apache.org/guides/development/guide-helping.html" class="externalLink">guide to helping with Maven</a>.</p>
+<p>General instructions on how to use the Javadoc Plugin can be found on the <a href="./usage.html">usage page</a>. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the <a href="http://docs.codehaus.org/display/MAVENUSER/Javadoc+Plugin" class="externalLink">plugin's wiki page</a>.</p>
+<p>In case you still have questions regarding the plugin's usage, please have a look at the <a href="./faq.html">FAQ</a> and feel free to contact the <a href="./mail-lists.html">user mailing list</a>. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the <a href="./mail-lists.html">mail archive</a>.</p>
+<p>If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our <a href="./issue-tracking.html">issue tracker</a>. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our <a href="./source-repository.html">source repository</a> and will find supplementary information in the <a href="http://maven.apache.org/guides/development/guide-helping.html" class="externalLink">guide to helping with Maven</a>.</p>
</div>
<div class="section"><h3>Examples</h3>
<p>The following examples show how to use the Javadoc Plugin in more advanced usecases:</p>
-<ul><li><a href="examples/aggregate.html">Aggregating Javadocs for Multi-Projects</a></li>
-<li><a href="examples/exclude-package-names.html">Excluding Packages</a></li>
-<li><a href="examples/group-configuration.html">Grouping Packages</a></li>
-<li><a href="examples/alternate-doclet.html">Using Alternate Doclet</a></li>
-<li><a href="examples/alternate-javadoc-tool.html">Using Alternate Javadoc Tool</a></li>
-<li><a href="examples/javadoc-resources.html">Using Javadoc Resources</a></li>
-<li><a href="examples/output-configuration.html">Using Alternative Output Directory</a></li>
-<li><a href="examples/stylesheet-configuration.html">Configuring Stylesheets</a></li>
-<li><a href="examples/help-configuration.html">Configuring Helpfile</a></li>
-<li><a href="examples/tag-configuration.html">Configuring Custom Javadoc Tags</a></li>
-<li><a href="examples/taglet-configuration.html">Configuring Custom Javadoc Taglet</a></li>
-<li><a href="examples/links-configuration.html">Configuring Links</a></li>
-<li><a href="examples/test-javadocs.html">Generating test Javadocs</a></li>
-<li><a href="examples/selective-javadocs-report.html">Selective Javadocs Reports</a></li>
-<li><a href="examples/fix-javadocs.html">Fixing Javadoc Comments</a></li>
+<ul><li><a href="./examples/aggregate.html">Aggregating Javadocs for Multi-Projects</a></li>
+<li><a href="./examples/exclude-package-names.html">Excluding Packages</a></li>
+<li><a href="./examples/group-configuration.html">Grouping Packages</a></li>
+<li><a href="./examples/alternate-doclet.html">Using Alternate Doclet</a></li>
+<li><a href="./examples/alternate-javadoc-tool.html">Using Alternate Javadoc Tool</a></li>
+<li><a href="./examples/javadoc-resources.html">Using Javadoc Resources</a></li>
+<li><a href="./examples/output-configuration.html">Using Alternative Output Directory</a></li>
+<li><a href="./examples/stylesheet-configuration.html">Configuring Stylesheets</a></li>
+<li><a href="./examples/help-configuration.html">Configuring Helpfile</a></li>
+<li><a href="./examples/tag-configuration.html">Configuring Custom Javadoc Tags</a></li>
+<li><a href="./examples/taglet-configuration.html">Configuring Custom Javadoc Taglet</a></li>
+<li><a href="./examples/links-configuration.html">Configuring Links</a></li>
+<li><a href="./examples/test-javadocs.html">Generating test Javadocs</a></li>
+<li><a href="./examples/selective-javadocs-report.html">Selective Javadocs Reports</a></li>
+<li><a href="./examples/fix-javadocs.html">Fixing Javadoc Comments</a></li>
</ul>
</div>
</div>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/integration.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/integration.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/integration.html Sun Aug 19 17:31:42 2012
@@ -73,8 +73,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -347,14 +347,14 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <a name="Overview"></a><div class="section"><h2>Overview</h2>
+ <div class="section"><h2>Overview</h2>
This project uses <a href="https://hudson.dev.java.net/" class="externalLink">Hudson</a>.</div>
-<a name="Access"></a><div class="section"><h2>Access</h2>
+<div class="section"><h2>Access</h2>
<p>The following is a link to the continuous integration system used by the project.</p>
<div class="source"><pre><a href="http://grid.sonatype.org/ci" class="externalLink">http://grid.sonatype.org/ci</a></pre>
</div>
</div>
-<a name="Notifiers"></a><div class="section"><h2>Notifiers</h2>
+<div class="section"><h2>Notifiers</h2>
<p>Configuration for notifying developers/users when a build is unsuccessful, including user information and notification mode.</p>
<table class="bodyTable"><tr class="a"><th>Type</th>
<th>Address</th>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/issue-tracking.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/issue-tracking.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/issue-tracking.html Sun Aug 19 17:31:42 2012
@@ -73,8 +73,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -347,9 +347,9 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <a name="Overview"></a><div class="section"><h2>Overview</h2>
+ <div class="section"><h2>Overview</h2>
This project uses <a href="http://www.atlassian.com/software/jira" class="externalLink">JIRA</a> a J2EE-based, issue tracking and project management application.</div>
-<a name="Issue_Tracking"></a><div class="section"><h2>Issue Tracking</h2>
+<div class="section"><h2>Issue Tracking</h2>
<p>Issues, bugs, and feature requests should be submitted to the following issue tracking system for this project.</p>
<div class="source"><pre><a href="http://jira.codehaus.org/browse/MJAVADOC" class="externalLink">http://jira.codehaus.org/browse/MJAVADOC</a></pre>
</div>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/jar-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/jar-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/jar-mojo.html Sun Aug 19 17:31:42 2012
@@ -73,8 +73,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -303,7 +303,7 @@
<div id="contentBox">
<div class="section"><h2><a name="javadoc:jar"></a>javadoc:jar</h2>
<p><strong>Full name</strong>:</p>
-<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6:jar</p>
+<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6.1:jar</p>
<p><strong>Description</strong>:</p>
<div>Bundles the Javadoc documentation for <code>main Java code</code>
in an <b>NON aggregator</b> project into a jar using the standard
@@ -352,7 +352,10 @@ See <a href="http://java.sun.com/j2se/1.
Jflag</a>. <br />
See <a href="http://java.sun.com/javase/technologies/hotspot/vmoptions.jsp" class="externalLink">
-vmoptions</a>.<br />
+vmoptions</a>. <br />
+
+See <a href="http://java.sun.com/j2se/1.4.2/docs/guide/net/properties.html" class="externalLink">
+Networking Properties</a>.<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#additionalparam">additionalparam</a></strong></td>
@@ -399,7 +402,10 @@ author</a>. <br />
<tr class="b"><td><strong><a href="#bootclasspath">bootclasspath</a></strong></td>
<td><code>String</code></td>
<td><code>2.5</code></td>
-<td>Specifies the paths where the boot classes reside. <br />
+<td>Specifies the paths where the boot classes reside. The
+<code>bootclasspath</code> can contain multiple paths by separating
+them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#bootclasspath" class="externalLink">
bootclasspath</a>. <br />
@@ -447,7 +453,7 @@ Inc.<a>]]></code><br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#bottom" class="externalLink">
bottom</a>. <br />
<br />
-<strong>Default value is</strong>: <code>Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.</code>.</td>
+<strong>Default value is</strong>: <code>Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#breakiterator">breakiterator</a></strong></td>
<td><code>boolean</code></td>
@@ -478,8 +484,10 @@ charset</a>. <br />
<tr class="a"><td><strong><a href="#debug">debug</a></strong></td>
<td><code>boolean</code></td>
<td><code>2.1</code></td>
-<td>Set this to 'true' to debug Javadoc plugin. With this, 'options'
-and 'files' files are provided. <br />
+<td>Set this to <code>true</code> to debug the Javadoc plugin. With
+this, <code>javadoc.bat(or.sh)</code>, <code>options</code>,
+<code>@packages</code> or <code>argfile</code> files are provided
+in the output directory. <br />
<br />
<strong>Default value is</strong>: <code>false</code>.</td>
</tr>
@@ -522,8 +530,8 @@ i.e.:
<pre>
<dependency>
-<groupId>commons-lang</groupId>
-<artifactId>commons-lang</artifactId>
+ <groupId>commons-lang</groupId>
+ <artifactId>commons-lang</artifactId>
</dependency>
</pre>
@@ -565,7 +573,11 @@ docencoding</a>.<br />
<tr class="a"><td><strong><a href="#docfilessubdirs">docfilessubdirs</a></strong></td>
<td><code>boolean</code></td>
<td><code>2.0</code></td>
-<td>Enables deep copying of "doc-files" directories. <br />
+<td>Enables deep copying of the <code>**/doc-files</code> directories
+and the specifc <code>resources</code> directory from the
+<code>javadocDirectory</code> directory (for instance,
+<code>src/main/javadoc/com/mycompany/myapp/doc-files</code> and
+<code>src/main/javadoc/resources</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docfilessubdirs" class="externalLink">
docfilessubdirs</a>. <br />
@@ -643,9 +655,9 @@ Javadoc</a>. <br />
<td><code>2.0</code></td>
<td>Specifies the path to the doclet starting class file (specified
with the <code>-doclet</code> option) and any jar files it depends
-on. The docletPath can contain multiple paths by separating them
-with a colon (<code>:</code>) on Solaris and a semi-colon
-(<code>;</code>) on Windows. <br />
+on. The <code>docletPath</code> can contain multiple paths by
+separating them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docletpath" class="externalLink">
docletpath</a>.<br />
@@ -682,8 +694,14 @@ reverted in 2.5. <br />
<td><code>2.0</code></td>
<td>Unconditionally excludes the specified packages and their
subpackages from the list formed by <code>-subpackages</code>.
-Multiple packages can be separated by colons (<code>:</code>).
-<br />
+Multiple packages can be separated by commas (<code>,</code>),
+colons (<code>:</code>) or semicolons (<code>;</code>). <br />
+
+Example:
+
+<pre>
+<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
+</pre><br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#exclude" class="externalLink">
exclude</a>. <br />
@@ -710,8 +728,8 @@ Java 1.4</a>.<br />
<td><code>String</code></td>
<td><code>2.0</code></td>
<td>Specifies the directories where extension classes reside. Separate
-directories in dirlist with a colon (<code>:</code>) on Solaris and
-a semi-colon (<code>;</code>) on Windows. <br />
+directories in <code>extdirs</code> with a colon (<code>:</code>)
+or a semi-colon (<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#extdirs" class="externalLink">
extdirs</a>.<br />
@@ -751,19 +769,30 @@ an asterisk (<code>*</code>) meaning &qu
Multiple patterns can be included in a group by separating them
with colons (<code>:</code>). <br />
-See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#group" class="externalLink">
-group</a>. <br />
-
Example:
<pre>
<groups>
<group>
<title>Core Packages</title>
- <packages>org.apache.core</packages>
+ <!-- To includes java.lang, java.lang.ref,
+ java.lang.reflect and only java.util
+ (i.e. not java.util.jar) -->
+ <packages>java.lang*:java.util</packages>
+ </group>
+ <group>
+ <title>Extension Packages</title>
+ <!-- To include javax.accessibility,
+ javax.crypto, ... (among others) -->
+ <packages>javax.*</packages>
</group>
</groups>
-</pre><br />
+</pre><b>Note</b>: using <code>java.lang.*</code> for
+<code>packages</code> would omit the <code>java.lang</code> package
+but using <code>java.lang*</code> will include it. <br />
+
+See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#group" class="externalLink">
+group</a>. <br />
See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/Group.html">
Javadoc</a>. <br />
@@ -804,24 +833,24 @@ in <code>src/main/javadoc</code>.
<pre>
<build>
-<plugins>
-<plugin>
-<groupId>org.apache.maven.plugins</groupId>
-<artifactId>maven-javadoc-plugin</artifactId>
-<configuration>
-<stylesheetfile>path/to/your/resource/yourhelp-doc.html</stylesheetfile>
-...
-</configuration>
-<dependencies>
-<dependency>
-<groupId>groupId</groupId>
-<artifactId>artifactId</artifactId>
-<version>version</version>
-</dependency>
-</dependencies>
-</plugin>
-...
-<plugins>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>
+ ...
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>groupId</groupId>
+ <artifactId>artifactId</artifactId>
+ <version>version</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ ...
+ <plugins>
</build>
</pre>
@@ -900,25 +929,29 @@ Java 5.0</a>. <br />
<td><code>2.0</code></td>
<td>Creates links to existing javadoc-generated documentation of
external referenced classes. <br />
-<b>Note 1</b>: only used is <code>isOffline</code> is set to
-<code>false</code>. <br />
-<b>Note 2</b>: all given links should have a fetchable
+<b>Notes</b>:
+
+<ol type="1"><li>only used is <code>isOffline</code> is set to
+<code>false</code>.</li>
+<li>all given links should have a fetchable
<code>/package-list</code> file. For instance:
<pre>
<links>
-<link>http://java.sun.com/j2se/1.4.2/docs/api</link>
+ <link>http://java.sun.com/j2se/1.4.2/docs/api</link>
<links>
</pre>
will be used because
<code>http://java.sun.com/j2se/1.4.2/docs/api/package-list</code>
-exists. <br />
-<b>Note 1</b>: if <code>detectLinks</code> is defined, the links
-between the project dependencies are automatically added. <b>Note
-2</b>: if <code>detectJavaApiLink</code> is defined, a Java API
-link, based on the Java verion of the project's sources, will be
-added automatically. <br />
+exists.</li>
+<li>if <code>detectLinks</code> is defined, the links between the
+project dependencies are automatically added.</li>
+<li>if <code>detectJavaApiLink</code> is defined, a Java API link,
+based on the Java verion of the project's sources, will be added
+automatically.</li>
+</ol>
+
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#link" class="externalLink">
link</a>.<br />
@@ -1062,7 +1095,13 @@ Standard Doclet undocumented option. <br
<td><code>String</code></td>
<td><code>2.0</code></td>
<td>Omits qualifying package name from ahead of class names in output.
-<br />
+Example:
+
+<pre>
+<noqualifier>all</noqualifier>
+or
+<noqualifier>packagename1:packagename2</noqualifier>
+</pre>
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#noqualifier" class="externalLink">
noqualifier</a>. <br />
@@ -1282,8 +1321,9 @@ Java 1.4</a>.<br />
<td><code>String</code></td>
<td><code>2.0</code></td>
<td>Specifies the source paths where the subpackages are located. The
-paths are separated with a colon (<code>:</code>) on Solaris and a
-semi-colon (<code>;</code>) on Windows. <br />
+<code>sourcepath</code> can contain multiple paths by separating
+them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#sourcepath" class="externalLink">
sourcepath</a>.<br />
@@ -1353,24 +1393,24 @@ be in <code>src/main/javadoc</code>.
<pre>
<build>
-<plugins>
-<plugin>
-<groupId>org.apache.maven.plugins</groupId>
-<artifactId>maven-javadoc-plugin</artifactId>
-<configuration>
-<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
-...
-</configuration>
-<dependencies>
-<dependency>
-<groupId>groupId</groupId>
-<artifactId>artifactId</artifactId>
-<version>version</version>
-</dependency>
-</dependencies>
-</plugin>
-...
-<plugins>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
+ ...
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>groupId</groupId>
+ <artifactId>artifactId</artifactId>
+ <version>version</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ ...
+ <plugins>
</build>
</pre>
@@ -1477,9 +1517,9 @@ Javadoc</a>. <br />
<td><code>String</code></td>
<td><code>2.0</code></td>
<td>Specifies the search paths for finding taglet class files (.class).
-The tagletPath can contain multiple paths by separating them with a
-colon (<code>:</code>) on Solaris and a semi-colon (<code>;</code>)
-on Windows. <br />
+The <code>tagletpath</code> can contain multiple paths by
+separating them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tagletpath" class="externalLink">
tagletpath</a>. <br />
@@ -1542,7 +1582,20 @@ Example:
<head>To Do:</head>
</tag>
</tags>
-</pre><br />
+</pre><b>Note</b>: the placement should be a combinaison of Xaoptcmf
+letters:
+
+<ul><li><b><code>X</code></b> (disable tag)</li>
+<li><b><code>a</code></b> (all)</li>
+<li><b><code>o</code></b> (overview)</li>
+<li><b><code>p</code></b> (packages)</li>
+<li><b><code>t</code></b> (types, that is classes and
+interfaces)</li>
+<li><b><code>c</code></b> (constructors)</li>
+<li><b><code>m</code></b> (methods)</li>
+<li><b><code>f</code></b> (fields)</li>
+</ul>
+
See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/Tag.html">Javadoc</a>.
<br />
@@ -1646,7 +1699,10 @@ See <a href="http://java.sun.com/j2se/1.
Jflag</a>. <br />
See <a href="http://java.sun.com/javase/technologies/hotspot/vmoptions.jsp" class="externalLink">
-vmoptions</a>.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+vmoptions</a>. <br />
+
+See <a href="http://java.sun.com/j2se/1.4.2/docs/guide/net/properties.html" class="externalLink">
+Networking Properties</a>.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>2.3</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${additionalJOption}</code></li>
@@ -1702,7 +1758,10 @@ author</a>. <br />
</ul>
<hr />
<p><strong><a name="bootclasspath">bootclasspath</a>:</strong></p>
-<div>Specifies the paths where the boot classes reside. <br />
+<div>Specifies the paths where the boot classes reside. The
+<code>bootclasspath</code> can contain multiple paths by separating
+them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#bootclasspath" class="externalLink">
bootclasspath</a>. <br />
@@ -1755,7 +1814,7 @@ bottom</a>. <br />
<li><strong>Since</strong>: <code>2.0</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${bottom}</code></li>
-<li><strong>Default</strong>: <code>Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.</code></li>
+<li><strong>Default</strong>: <code>Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.</code></li>
</ul>
<hr />
<p><strong><a name="breakiterator">breakiterator</a>:</strong></p>
@@ -1788,8 +1847,10 @@ charset</a>. <br />
</ul>
<hr />
<p><strong><a name="debug">debug</a>:</strong></p>
-<div>Set this to 'true' to debug Javadoc plugin. With this, 'options'
-and 'files' files are provided. <br />
+<div>Set this to <code>true</code> to debug the Javadoc plugin. With
+this, <code>javadoc.bat(or.sh)</code>, <code>options</code>,
+<code>@packages</code> or <code>argfile</code> files are provided
+in the output directory. <br />
</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.1</code></li>
<li><strong>Required</strong>: <code>No</code></li>
@@ -1837,8 +1898,8 @@ i.e.:
<pre>
<dependency>
-<groupId>commons-lang</groupId>
-<artifactId>commons-lang</artifactId>
+ <groupId>commons-lang</groupId>
+ <artifactId>commons-lang</artifactId>
</dependency>
</pre>
@@ -1886,7 +1947,11 @@ docencoding</a>.</div><ul><li><strong>Ty
</ul>
<hr />
<p><strong><a name="docfilessubdirs">docfilessubdirs</a>:</strong></p>
-<div>Enables deep copying of "doc-files" directories. <br />
+<div>Enables deep copying of the <code>**/doc-files</code> directories
+and the specifc <code>resources</code> directory from the
+<code>javadocDirectory</code> directory (for instance,
+<code>src/main/javadoc/com/mycompany/myapp/doc-files</code> and
+<code>src/main/javadoc/resources</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docfilessubdirs" class="externalLink">
docfilessubdirs</a>. <br />
@@ -1969,9 +2034,9 @@ Javadoc</a>. <br />
<p><strong><a name="docletPath">docletPath</a>:</strong></p>
<div>Specifies the path to the doclet starting class file (specified
with the <code>-doclet</code> option) and any jar files it depends
-on. The docletPath can contain multiple paths by separating them
-with a colon (<code>:</code>) on Solaris and a semi-colon
-(<code>;</code>) on Windows. <br />
+on. The <code>docletPath</code> can contain multiple paths by
+separating them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docletpath" class="externalLink">
docletpath</a>.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
@@ -2013,8 +2078,14 @@ reverted in 2.5. <br />
<p><strong><a name="excludePackageNames">excludePackageNames</a>:</strong></p>
<div>Unconditionally excludes the specified packages and their
subpackages from the list formed by <code>-subpackages</code>.
-Multiple packages can be separated by colons (<code>:</code>).
-<br />
+Multiple packages can be separated by commas (<code>,</code>),
+colons (<code>:</code>) or semicolons (<code>;</code>). <br />
+
+Example:
+
+<pre>
+<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
+</pre><br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#exclude" class="externalLink">
exclude</a>. <br />
@@ -2043,8 +2114,8 @@ Java 1.4</a>.</div><ul><li><strong>Type<
<hr />
<p><strong><a name="extdirs">extdirs</a>:</strong></p>
<div>Specifies the directories where extension classes reside. Separate
-directories in dirlist with a colon (<code>:</code>) on Solaris and
-a semi-colon (<code>;</code>) on Windows. <br />
+directories in <code>extdirs</code> with a colon (<code>:</code>)
+or a semi-colon (<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#extdirs" class="externalLink">
extdirs</a>.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
@@ -2089,19 +2160,30 @@ an asterisk (<code>*</code>) meaning &qu
Multiple patterns can be included in a group by separating them
with colons (<code>:</code>). <br />
-See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#group" class="externalLink">
-group</a>. <br />
-
Example:
<pre>
<groups>
<group>
<title>Core Packages</title>
- <packages>org.apache.core</packages>
+ <!-- To includes java.lang, java.lang.ref,
+ java.lang.reflect and only java.util
+ (i.e. not java.util.jar) -->
+ <packages>java.lang*:java.util</packages>
+ </group>
+ <group>
+ <title>Extension Packages</title>
+ <!-- To include javax.accessibility,
+ javax.crypto, ... (among others) -->
+ <packages>javax.*</packages>
</group>
</groups>
-</pre><br />
+</pre><b>Note</b>: using <code>java.lang.*</code> for
+<code>packages</code> would omit the <code>java.lang</code> package
+but using <code>java.lang*</code> will include it. <br />
+
+See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#group" class="externalLink">
+group</a>. <br />
See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/Group.html">
Javadoc</a>. <br />
@@ -2144,24 +2226,24 @@ in <code>src/main/javadoc</code>.
<pre>
<build>
-<plugins>
-<plugin>
-<groupId>org.apache.maven.plugins</groupId>
-<artifactId>maven-javadoc-plugin</artifactId>
-<configuration>
-<stylesheetfile>path/to/your/resource/yourhelp-doc.html</stylesheetfile>
-...
-</configuration>
-<dependencies>
-<dependency>
-<groupId>groupId</groupId>
-<artifactId>artifactId</artifactId>
-<version>version</version>
-</dependency>
-</dependencies>
-</plugin>
-...
-<plugins>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>
+ ...
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>groupId</groupId>
+ <artifactId>artifactId</artifactId>
+ <version>version</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ ...
+ <plugins>
</build>
</pre>
@@ -2248,25 +2330,29 @@ Java 5.0</a>. <br />
<p><strong><a name="links">links</a>:</strong></p>
<div>Creates links to existing javadoc-generated documentation of
external referenced classes. <br />
-<b>Note 1</b>: only used is <code>isOffline</code> is set to
-<code>false</code>. <br />
-<b>Note 2</b>: all given links should have a fetchable
+<b>Notes</b>:
+
+<ol type="1"><li>only used is <code>isOffline</code> is set to
+<code>false</code>.</li>
+<li>all given links should have a fetchable
<code>/package-list</code> file. For instance:
<pre>
<links>
-<link>http://java.sun.com/j2se/1.4.2/docs/api</link>
+ <link>http://java.sun.com/j2se/1.4.2/docs/api</link>
<links>
</pre>
will be used because
<code>http://java.sun.com/j2se/1.4.2/docs/api/package-list</code>
-exists. <br />
-<b>Note 1</b>: if <code>detectLinks</code> is defined, the links
-between the project dependencies are automatically added. <b>Note
-2</b>: if <code>detectJavaApiLink</code> is defined, a Java API
-link, based on the Java verion of the project's sources, will be
-added automatically. <br />
+exists.</li>
+<li>if <code>detectLinks</code> is defined, the links between the
+project dependencies are automatically added.</li>
+<li>if <code>detectJavaApiLink</code> is defined, a Java API link,
+based on the Java verion of the project's sources, will be added
+automatically.</li>
+</ol>
+
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#link" class="externalLink">
link</a>.</div><ul><li><strong>Type</strong>: <code>java.util.ArrayList</code></li>
@@ -2431,7 +2517,13 @@ Standard Doclet undocumented option. <br
<hr />
<p><strong><a name="noqualifier">noqualifier</a>:</strong></p>
<div>Omits qualifying package name from ahead of class names in output.
-<br />
+Example:
+
+<pre>
+<noqualifier>all</noqualifier>
+or
+<noqualifier>packagename1:packagename2</noqualifier>
+</pre>
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#noqualifier" class="externalLink">
noqualifier</a>. <br />
@@ -2698,8 +2790,9 @@ Java 1.4</a>.</div><ul><li><strong>Type<
<hr />
<p><strong><a name="sourcepath">sourcepath</a>:</strong></p>
<div>Specifies the source paths where the subpackages are located. The
-paths are separated with a colon (<code>:</code>) on Solaris and a
-semi-colon (<code>;</code>) on Windows. <br />
+<code>sourcepath</code> can contain multiple paths by separating
+them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#sourcepath" class="externalLink">
sourcepath</a>.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
@@ -2775,24 +2868,24 @@ be in <code>src/main/javadoc</code>.
<pre>
<build>
-<plugins>
-<plugin>
-<groupId>org.apache.maven.plugins</groupId>
-<artifactId>maven-javadoc-plugin</artifactId>
-<configuration>
-<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
-...
-</configuration>
-<dependencies>
-<dependency>
-<groupId>groupId</groupId>
-<artifactId>artifactId</artifactId>
-<version>version</version>
-</dependency>
-</dependencies>
-</plugin>
-...
-<plugins>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
+ ...
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>groupId</groupId>
+ <artifactId>artifactId</artifactId>
+ <version>version</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ ...
+ <plugins>
</build>
</pre>
@@ -2904,9 +2997,9 @@ Javadoc</a>. <br />
<hr />
<p><strong><a name="tagletpath">tagletpath</a>:</strong></p>
<div>Specifies the search paths for finding taglet class files (.class).
-The tagletPath can contain multiple paths by separating them with a
-colon (<code>:</code>) on Solaris and a semi-colon (<code>;</code>)
-on Windows. <br />
+The <code>tagletpath</code> can contain multiple paths by
+separating them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tagletpath" class="externalLink">
tagletpath</a>. <br />
@@ -2971,7 +3064,20 @@ Example:
<head>To Do:</head>
</tag>
</tags>
-</pre><br />
+</pre><b>Note</b>: the placement should be a combinaison of Xaoptcmf
+letters:
+
+<ul><li><b><code>X</code></b> (disable tag)</li>
+<li><b><code>a</code></b> (all)</li>
+<li><b><code>o</code></b> (overview)</li>
+<li><b><code>p</code></b> (packages)</li>
+<li><b><code>t</code></b> (types, that is classes and
+interfaces)</li>
+<li><b><code>c</code></b> (constructors)</li>
+<li><b><code>m</code></b> (methods)</li>
+<li><b><code>f</code></b> (fields)</li>
+</ul>
+
See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/Tag.html">Javadoc</a>.
<br />
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/javadoc-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/javadoc-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/javadoc-mojo.html Sun Aug 19 17:31:42 2012
@@ -73,8 +73,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -304,7 +304,7 @@
<div class="section"><h2><a name="javadoc:javadoc"></a>javadoc:javadoc</h2>
<p><strong>Note</strong>:This goal should be used as a Maven report.</p>
<p><strong>Full name</strong>:</p>
-<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6:javadoc</p>
+<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6.1:javadoc</p>
<p><strong>Description</strong>:</p>
<div>Generates documentation for the <code>Java code</code> in an <b>NON
aggregator</b> project using the standard <a href="http://java.sun.com/j2se/javadoc/" class="externalLink">Javadoc Tool</a>.</div><p><strong>Attributes</strong>:</p>
@@ -335,7 +335,7 @@ d</a>. <br />
<td><code>2.0</code></td>
<td>Specifies the destination directory where javadoc saves the
generated HTML files.<br />
-</td>
+<strong>Default value is</strong>: <code>${project.reporting.outputDirectory}/apidocs</code>.</td>
</tr>
</table>
</div>
@@ -359,7 +359,10 @@ See <a href="http://java.sun.com/j2se/1.
Jflag</a>. <br />
See <a href="http://java.sun.com/javase/technologies/hotspot/vmoptions.jsp" class="externalLink">
-vmoptions</a>.<br />
+vmoptions</a>. <br />
+
+See <a href="http://java.sun.com/j2se/1.4.2/docs/guide/net/properties.html" class="externalLink">
+Networking Properties</a>.<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#additionalparam">additionalparam</a></strong></td>
@@ -391,7 +394,10 @@ author</a>. <br />
<tr class="a"><td><strong><a href="#bootclasspath">bootclasspath</a></strong></td>
<td><code>String</code></td>
<td><code>2.5</code></td>
-<td>Specifies the paths where the boot classes reside. <br />
+<td>Specifies the paths where the boot classes reside. The
+<code>bootclasspath</code> can contain multiple paths by separating
+them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#bootclasspath" class="externalLink">
bootclasspath</a>. <br />
@@ -439,7 +445,7 @@ Inc.<a>]]></code><br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#bottom" class="externalLink">
bottom</a>. <br />
<br />
-<strong>Default value is</strong>: <code>Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.</code>.</td>
+<strong>Default value is</strong>: <code>Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#breakiterator">breakiterator</a></strong></td>
<td><code>boolean</code></td>
@@ -470,15 +476,18 @@ charset</a>. <br />
<tr class="b"><td><strong><a href="#debug">debug</a></strong></td>
<td><code>boolean</code></td>
<td><code>2.1</code></td>
-<td>Set this to 'true' to debug Javadoc plugin. With this, 'options'
-and 'files' files are provided. <br />
+<td>Set this to <code>true</code> to debug the Javadoc plugin. With
+this, <code>javadoc.bat(or.sh)</code>, <code>options</code>,
+<code>@packages</code> or <code>argfile</code> files are provided
+in the output directory. <br />
<br />
<strong>Default value is</strong>: <code>false</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#description">description</a></strong></td>
<td><code>String</code></td>
<td><code>2.1</code></td>
-<td>The description of the Javadoc report.<br />
+<td>The description of the Javadoc report to be displayed in the Maven
+Generated Reports page (i.e. <code>project-reports.html</code>).<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#destDir">destDir</a></strong></td>
@@ -519,8 +528,8 @@ i.e.:
<pre>
<dependency>
-<groupId>commons-lang</groupId>
-<artifactId>commons-lang</artifactId>
+ <groupId>commons-lang</groupId>
+ <artifactId>commons-lang</artifactId>
</dependency>
</pre>
@@ -562,7 +571,11 @@ docencoding</a>.<br />
<tr class="a"><td><strong><a href="#docfilessubdirs">docfilessubdirs</a></strong></td>
<td><code>boolean</code></td>
<td><code>2.0</code></td>
-<td>Enables deep copying of "doc-files" directories. <br />
+<td>Enables deep copying of the <code>**/doc-files</code> directories
+and the specifc <code>resources</code> directory from the
+<code>javadocDirectory</code> directory (for instance,
+<code>src/main/javadoc/com/mycompany/myapp/doc-files</code> and
+<code>src/main/javadoc/resources</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docfilessubdirs" class="externalLink">
docfilessubdirs</a>. <br />
@@ -640,9 +653,9 @@ Javadoc</a>. <br />
<td><code>2.0</code></td>
<td>Specifies the path to the doclet starting class file (specified
with the <code>-doclet</code> option) and any jar files it depends
-on. The docletPath can contain multiple paths by separating them
-with a colon (<code>:</code>) on Solaris and a semi-colon
-(<code>;</code>) on Windows. <br />
+on. The <code>docletPath</code> can contain multiple paths by
+separating them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docletpath" class="externalLink">
docletpath</a>.<br />
@@ -679,8 +692,14 @@ reverted in 2.5. <br />
<td><code>2.0</code></td>
<td>Unconditionally excludes the specified packages and their
subpackages from the list formed by <code>-subpackages</code>.
-Multiple packages can be separated by colons (<code>:</code>).
-<br />
+Multiple packages can be separated by commas (<code>,</code>),
+colons (<code>:</code>) or semicolons (<code>;</code>). <br />
+
+Example:
+
+<pre>
+<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
+</pre><br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#exclude" class="externalLink">
exclude</a>. <br />
@@ -707,8 +726,8 @@ Java 1.4</a>.<br />
<td><code>String</code></td>
<td><code>2.0</code></td>
<td>Specifies the directories where extension classes reside. Separate
-directories in dirlist with a colon (<code>:</code>) on Solaris and
-a semi-colon (<code>;</code>) on Windows. <br />
+directories in <code>extdirs</code> with a colon (<code>:</code>)
+or a semi-colon (<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#extdirs" class="externalLink">
extdirs</a>.<br />
@@ -740,19 +759,30 @@ an asterisk (<code>*</code>) meaning &qu
Multiple patterns can be included in a group by separating them
with colons (<code>:</code>). <br />
-See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#group" class="externalLink">
-group</a>. <br />
-
Example:
<pre>
<groups>
<group>
<title>Core Packages</title>
- <packages>org.apache.core</packages>
+ <!-- To includes java.lang, java.lang.ref,
+ java.lang.reflect and only java.util
+ (i.e. not java.util.jar) -->
+ <packages>java.lang*:java.util</packages>
+ </group>
+ <group>
+ <title>Extension Packages</title>
+ <!-- To include javax.accessibility,
+ javax.crypto, ... (among others) -->
+ <packages>javax.*</packages>
</group>
</groups>
-</pre><br />
+</pre><b>Note</b>: using <code>java.lang.*</code> for
+<code>packages</code> would omit the <code>java.lang</code> package
+but using <code>java.lang*</code> will include it. <br />
+
+See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#group" class="externalLink">
+group</a>. <br />
See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/Group.html">
Javadoc</a>. <br />
@@ -793,24 +823,24 @@ in <code>src/main/javadoc</code>.
<pre>
<build>
-<plugins>
-<plugin>
-<groupId>org.apache.maven.plugins</groupId>
-<artifactId>maven-javadoc-plugin</artifactId>
-<configuration>
-<stylesheetfile>path/to/your/resource/yourhelp-doc.html</stylesheetfile>
-...
-</configuration>
-<dependencies>
-<dependency>
-<groupId>groupId</groupId>
-<artifactId>artifactId</artifactId>
-<version>version</version>
-</dependency>
-</dependencies>
-</plugin>
-...
-<plugins>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>
+ ...
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>groupId</groupId>
+ <artifactId>artifactId</artifactId>
+ <version>version</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ ...
+ <plugins>
</build>
</pre>
@@ -883,25 +913,29 @@ Java 5.0</a>. <br />
<td><code>2.0</code></td>
<td>Creates links to existing javadoc-generated documentation of
external referenced classes. <br />
-<b>Note 1</b>: only used is <code>isOffline</code> is set to
-<code>false</code>. <br />
-<b>Note 2</b>: all given links should have a fetchable
+<b>Notes</b>:
+
+<ol type="1"><li>only used is <code>isOffline</code> is set to
+<code>false</code>.</li>
+<li>all given links should have a fetchable
<code>/package-list</code> file. For instance:
<pre>
<links>
-<link>http://java.sun.com/j2se/1.4.2/docs/api</link>
+ <link>http://java.sun.com/j2se/1.4.2/docs/api</link>
<links>
</pre>
will be used because
<code>http://java.sun.com/j2se/1.4.2/docs/api/package-list</code>
-exists. <br />
-<b>Note 1</b>: if <code>detectLinks</code> is defined, the links
-between the project dependencies are automatically added. <b>Note
-2</b>: if <code>detectJavaApiLink</code> is defined, a Java API
-link, based on the Java verion of the project's sources, will be
-added automatically. <br />
+exists.</li>
+<li>if <code>detectLinks</code> is defined, the links between the
+project dependencies are automatically added.</li>
+<li>if <code>detectJavaApiLink</code> is defined, a Java API link,
+based on the Java verion of the project's sources, will be added
+automatically.</li>
+</ol>
+
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#link" class="externalLink">
link</a>.<br />
@@ -964,7 +998,8 @@ specified, the default unit is <code>m</
<tr class="a"><td><strong><a href="#name">name</a></strong></td>
<td><code>String</code></td>
<td><code>2.1</code></td>
-<td>The name of the Javadoc report.<br />
+<td>The name of the Javadoc report to be displayed in the Maven
+Generated Reports page (i.e. <code>project-reports.html</code>).<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#nocomment">nocomment</a></strong></td>
@@ -1051,7 +1086,13 @@ Standard Doclet undocumented option. <br
<td><code>String</code></td>
<td><code>2.0</code></td>
<td>Omits qualifying package name from ahead of class names in output.
-<br />
+Example:
+
+<pre>
+<noqualifier>all</noqualifier>
+or
+<noqualifier>packagename1:packagename2</noqualifier>
+</pre>
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#noqualifier" class="externalLink">
noqualifier</a>. <br />
@@ -1271,8 +1312,9 @@ Java 1.4</a>.<br />
<td><code>String</code></td>
<td><code>2.0</code></td>
<td>Specifies the source paths where the subpackages are located. The
-paths are separated with a colon (<code>:</code>) on Solaris and a
-semi-colon (<code>;</code>) on Windows. <br />
+<code>sourcepath</code> can contain multiple paths by separating
+them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#sourcepath" class="externalLink">
sourcepath</a>.<br />
@@ -1342,24 +1384,24 @@ be in <code>src/main/javadoc</code>.
<pre>
<build>
-<plugins>
-<plugin>
-<groupId>org.apache.maven.plugins</groupId>
-<artifactId>maven-javadoc-plugin</artifactId>
-<configuration>
-<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
-...
-</configuration>
-<dependencies>
-<dependency>
-<groupId>groupId</groupId>
-<artifactId>artifactId</artifactId>
-<version>version</version>
-</dependency>
-</dependencies>
-</plugin>
-...
-<plugins>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
+ ...
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>groupId</groupId>
+ <artifactId>artifactId</artifactId>
+ <version>version</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ ...
+ <plugins>
</build>
</pre>
@@ -1466,9 +1508,9 @@ Javadoc</a>. <br />
<td><code>String</code></td>
<td><code>2.0</code></td>
<td>Specifies the search paths for finding taglet class files (.class).
-The tagletPath can contain multiple paths by separating them with a
-colon (<code>:</code>) on Solaris and a semi-colon (<code>;</code>)
-on Windows. <br />
+The <code>tagletpath</code> can contain multiple paths by
+separating them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tagletpath" class="externalLink">
tagletpath</a>. <br />
@@ -1531,7 +1573,20 @@ Example:
<head>To Do:</head>
</tag>
</tags>
-</pre><br />
+</pre><b>Note</b>: the placement should be a combinaison of Xaoptcmf
+letters:
+
+<ul><li><b><code>X</code></b> (disable tag)</li>
+<li><b><code>a</code></b> (all)</li>
+<li><b><code>o</code></b> (overview)</li>
+<li><b><code>p</code></b> (packages)</li>
+<li><b><code>t</code></b> (types, that is classes and
+interfaces)</li>
+<li><b><code>c</code></b> (constructors)</li>
+<li><b><code>m</code></b> (methods)</li>
+<li><b><code>f</code></b> (fields)</li>
+</ul>
+
See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/Tag.html">Javadoc</a>.
<br />
@@ -1627,7 +1682,10 @@ See <a href="http://java.sun.com/j2se/1.
Jflag</a>. <br />
See <a href="http://java.sun.com/javase/technologies/hotspot/vmoptions.jsp" class="externalLink">
-vmoptions</a>.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+vmoptions</a>. <br />
+
+See <a href="http://java.sun.com/j2se/1.4.2/docs/guide/net/properties.html" class="externalLink">
+Networking Properties</a>.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>2.3</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${additionalJOption}</code></li>
@@ -1666,7 +1724,10 @@ author</a>. <br />
</ul>
<hr />
<p><strong><a name="bootclasspath">bootclasspath</a>:</strong></p>
-<div>Specifies the paths where the boot classes reside. <br />
+<div>Specifies the paths where the boot classes reside. The
+<code>bootclasspath</code> can contain multiple paths by separating
+them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#bootclasspath" class="externalLink">
bootclasspath</a>. <br />
@@ -1719,7 +1780,7 @@ bottom</a>. <br />
<li><strong>Since</strong>: <code>2.0</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${bottom}</code></li>
-<li><strong>Default</strong>: <code>Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.</code></li>
+<li><strong>Default</strong>: <code>Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.</code></li>
</ul>
<hr />
<p><strong><a name="breakiterator">breakiterator</a>:</strong></p>
@@ -1752,8 +1813,10 @@ charset</a>. <br />
</ul>
<hr />
<p><strong><a name="debug">debug</a>:</strong></p>
-<div>Set this to 'true' to debug Javadoc plugin. With this, 'options'
-and 'files' files are provided. <br />
+<div>Set this to <code>true</code> to debug the Javadoc plugin. With
+this, <code>javadoc.bat(or.sh)</code>, <code>options</code>,
+<code>@packages</code> or <code>argfile</code> files are provided
+in the output directory. <br />
</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.1</code></li>
<li><strong>Required</strong>: <code>No</code></li>
@@ -1762,7 +1825,8 @@ and 'files' files are provided. <br />
</ul>
<hr />
<p><strong><a name="description">description</a>:</strong></p>
-<div>The description of the Javadoc report.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<div>The description of the Javadoc report to be displayed in the Maven
+Generated Reports page (i.e. <code>project-reports.html</code>).</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>2.1</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${description}</code></li>
@@ -1808,8 +1872,8 @@ i.e.:
<pre>
<dependency>
-<groupId>commons-lang</groupId>
-<artifactId>commons-lang</artifactId>
+ <groupId>commons-lang</groupId>
+ <artifactId>commons-lang</artifactId>
</dependency>
</pre>
@@ -1857,7 +1921,11 @@ docencoding</a>.</div><ul><li><strong>Ty
</ul>
<hr />
<p><strong><a name="docfilessubdirs">docfilessubdirs</a>:</strong></p>
-<div>Enables deep copying of "doc-files" directories. <br />
+<div>Enables deep copying of the <code>**/doc-files</code> directories
+and the specifc <code>resources</code> directory from the
+<code>javadocDirectory</code> directory (for instance,
+<code>src/main/javadoc/com/mycompany/myapp/doc-files</code> and
+<code>src/main/javadoc/resources</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docfilessubdirs" class="externalLink">
docfilessubdirs</a>. <br />
@@ -1940,9 +2008,9 @@ Javadoc</a>. <br />
<p><strong><a name="docletPath">docletPath</a>:</strong></p>
<div>Specifies the path to the doclet starting class file (specified
with the <code>-doclet</code> option) and any jar files it depends
-on. The docletPath can contain multiple paths by separating them
-with a colon (<code>:</code>) on Solaris and a semi-colon
-(<code>;</code>) on Windows. <br />
+on. The <code>docletPath</code> can contain multiple paths by
+separating them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docletpath" class="externalLink">
docletpath</a>.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
@@ -1984,8 +2052,14 @@ reverted in 2.5. <br />
<p><strong><a name="excludePackageNames">excludePackageNames</a>:</strong></p>
<div>Unconditionally excludes the specified packages and their
subpackages from the list formed by <code>-subpackages</code>.
-Multiple packages can be separated by colons (<code>:</code>).
-<br />
+Multiple packages can be separated by commas (<code>,</code>),
+colons (<code>:</code>) or semicolons (<code>;</code>). <br />
+
+Example:
+
+<pre>
+<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
+</pre><br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#exclude" class="externalLink">
exclude</a>. <br />
@@ -2014,8 +2088,8 @@ Java 1.4</a>.</div><ul><li><strong>Type<
<hr />
<p><strong><a name="extdirs">extdirs</a>:</strong></p>
<div>Specifies the directories where extension classes reside. Separate
-directories in dirlist with a colon (<code>:</code>) on Solaris and
-a semi-colon (<code>;</code>) on Windows. <br />
+directories in <code>extdirs</code> with a colon (<code>:</code>)
+or a semi-colon (<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#extdirs" class="externalLink">
extdirs</a>.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
@@ -2051,19 +2125,30 @@ an asterisk (<code>*</code>) meaning &qu
Multiple patterns can be included in a group by separating them
with colons (<code>:</code>). <br />
-See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#group" class="externalLink">
-group</a>. <br />
-
Example:
<pre>
<groups>
<group>
<title>Core Packages</title>
- <packages>org.apache.core</packages>
+ <!-- To includes java.lang, java.lang.ref,
+ java.lang.reflect and only java.util
+ (i.e. not java.util.jar) -->
+ <packages>java.lang*:java.util</packages>
+ </group>
+ <group>
+ <title>Extension Packages</title>
+ <!-- To include javax.accessibility,
+ javax.crypto, ... (among others) -->
+ <packages>javax.*</packages>
</group>
</groups>
-</pre><br />
+</pre><b>Note</b>: using <code>java.lang.*</code> for
+<code>packages</code> would omit the <code>java.lang</code> package
+but using <code>java.lang*</code> will include it. <br />
+
+See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#group" class="externalLink">
+group</a>. <br />
See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/Group.html">
Javadoc</a>. <br />
@@ -2106,24 +2191,24 @@ in <code>src/main/javadoc</code>.
<pre>
<build>
-<plugins>
-<plugin>
-<groupId>org.apache.maven.plugins</groupId>
-<artifactId>maven-javadoc-plugin</artifactId>
-<configuration>
-<stylesheetfile>path/to/your/resource/yourhelp-doc.html</stylesheetfile>
-...
-</configuration>
-<dependencies>
-<dependency>
-<groupId>groupId</groupId>
-<artifactId>artifactId</artifactId>
-<version>version</version>
-</dependency>
-</dependencies>
-</plugin>
-...
-<plugins>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>
+ ...
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>groupId</groupId>
+ <artifactId>artifactId</artifactId>
+ <version>version</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ ...
+ <plugins>
</build>
</pre>
@@ -2203,25 +2288,29 @@ Java 5.0</a>. <br />
<p><strong><a name="links">links</a>:</strong></p>
<div>Creates links to existing javadoc-generated documentation of
external referenced classes. <br />
-<b>Note 1</b>: only used is <code>isOffline</code> is set to
-<code>false</code>. <br />
-<b>Note 2</b>: all given links should have a fetchable
+<b>Notes</b>:
+
+<ol type="1"><li>only used is <code>isOffline</code> is set to
+<code>false</code>.</li>
+<li>all given links should have a fetchable
<code>/package-list</code> file. For instance:
<pre>
<links>
-<link>http://java.sun.com/j2se/1.4.2/docs/api</link>
+ <link>http://java.sun.com/j2se/1.4.2/docs/api</link>
<links>
</pre>
will be used because
<code>http://java.sun.com/j2se/1.4.2/docs/api/package-list</code>
-exists. <br />
-<b>Note 1</b>: if <code>detectLinks</code> is defined, the links
-between the project dependencies are automatically added. <b>Note
-2</b>: if <code>detectJavaApiLink</code> is defined, a Java API
-link, based on the Java verion of the project's sources, will be
-added automatically. <br />
+exists.</li>
+<li>if <code>detectLinks</code> is defined, the links between the
+project dependencies are automatically added.</li>
+<li>if <code>detectJavaApiLink</code> is defined, a Java API link,
+based on the Java verion of the project's sources, will be added
+automatically.</li>
+</ol>
+
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#link" class="externalLink">
link</a>.</div><ul><li><strong>Type</strong>: <code>java.util.ArrayList</code></li>
@@ -2291,7 +2380,8 @@ specified, the default unit is <code>m</
</ul>
<hr />
<p><strong><a name="name">name</a>:</strong></p>
-<div>The name of the Javadoc report.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<div>The name of the Javadoc report to be displayed in the Maven
+Generated Reports page (i.e. <code>project-reports.html</code>).</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>2.1</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${name}</code></li>
@@ -2393,7 +2483,13 @@ Standard Doclet undocumented option. <br
<hr />
<p><strong><a name="noqualifier">noqualifier</a>:</strong></p>
<div>Omits qualifying package name from ahead of class names in output.
-<br />
+Example:
+
+<pre>
+<noqualifier>all</noqualifier>
+or
+<noqualifier>packagename1:packagename2</noqualifier>
+</pre>
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#noqualifier" class="externalLink">
noqualifier</a>. <br />
@@ -2582,7 +2678,8 @@ Since Java 5.0. <br />
generated HTML files.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Since</strong>: <code>2.0</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
-<li><strong>Expression</strong>: <code>${project.reporting.outputDirectory}/apidocs</code></li>
+<li><strong>Expression</strong>: <code>${reportOutputDirectory}</code></li>
+<li><strong>Default</strong>: <code>${project.reporting.outputDirectory}/apidocs</code></li>
</ul>
<hr />
<p><strong><a name="resourcesArtifacts">resourcesArtifacts</a>:</strong></p>
@@ -2668,8 +2765,9 @@ Java 1.4</a>.</div><ul><li><strong>Type<
<hr />
<p><strong><a name="sourcepath">sourcepath</a>:</strong></p>
<div>Specifies the source paths where the subpackages are located. The
-paths are separated with a colon (<code>:</code>) on Solaris and a
-semi-colon (<code>;</code>) on Windows. <br />
+<code>sourcepath</code> can contain multiple paths by separating
+them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#sourcepath" class="externalLink">
sourcepath</a>.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
@@ -2745,24 +2843,24 @@ be in <code>src/main/javadoc</code>.
<pre>
<build>
-<plugins>
-<plugin>
-<groupId>org.apache.maven.plugins</groupId>
-<artifactId>maven-javadoc-plugin</artifactId>
-<configuration>
-<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
-...
-</configuration>
-<dependencies>
-<dependency>
-<groupId>groupId</groupId>
-<artifactId>artifactId</artifactId>
-<version>version</version>
-</dependency>
-</dependencies>
-</plugin>
-...
-<plugins>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>
+ ...
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>groupId</groupId>
+ <artifactId>artifactId</artifactId>
+ <version>version</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ ...
+ <plugins>
</build>
</pre>
@@ -2874,9 +2972,9 @@ Javadoc</a>. <br />
<hr />
<p><strong><a name="tagletpath">tagletpath</a>:</strong></p>
<div>Specifies the search paths for finding taglet class files (.class).
-The tagletPath can contain multiple paths by separating them with a
-colon (<code>:</code>) on Solaris and a semi-colon (<code>;</code>)
-on Windows. <br />
+The <code>tagletpath</code> can contain multiple paths by
+separating them with a colon (<code>:</code>) or a semi-colon
+(<code>;</code>). <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tagletpath" class="externalLink">
tagletpath</a>. <br />
@@ -2941,7 +3039,20 @@ Example:
<head>To Do:</head>
</tag>
</tags>
-</pre><br />
+</pre><b>Note</b>: the placement should be a combinaison of Xaoptcmf
+letters:
+
+<ul><li><b><code>X</code></b> (disable tag)</li>
+<li><b><code>a</code></b> (all)</li>
+<li><b><code>o</code></b> (overview)</li>
+<li><b><code>p</code></b> (packages)</li>
+<li><b><code>t</code></b> (types, that is classes and
+interfaces)</li>
+<li><b><code>c</code></b> (constructors)</li>
+<li><b><code>m</code></b> (methods)</li>
+<li><b><code>f</code></b> (fields)</li>
+</ul>
+
See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/Tag.html">Javadoc</a>.
<br />