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 [19/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/test-aggregate-jar-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/test-aggregate-jar-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/test-aggregate-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:test-aggregate-jar"></a>javadoc:test-aggregate-jar</h2>
<p><strong>Full name</strong>:</p>
-<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6:test-aggregate-jar</p>
+<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6.1:test-aggregate-jar</p>
<p><strong>Description</strong>:</p>
<div>Bundles the Javadoc documentation for <code>Java Test code</code>
in an <b>aggregator</b> project into a jar using the standard <a href="http://java.sun.com/j2se/javadoc/" class="externalLink">Javadoc Tool</a>.</div><p><strong>Attributes</strong>:</p>
@@ -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.6</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.6</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.6</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.6</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.6</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.6</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.6</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.6</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 />
@@ -1687,7 +1740,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>
@@ -1743,7 +1799,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 />
@@ -1796,7 +1855,7 @@ bottom</a>. <br />
<li><strong>Since</strong>: <code>2.6</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>
@@ -1829,8 +1888,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>
@@ -1878,8 +1939,8 @@ i.e.:
<pre>
<dependency>
-<groupId>commons-lang</groupId>
-<artifactId>commons-lang</artifactId>
+ <groupId>commons-lang</groupId>
+ <artifactId>commons-lang</artifactId>
</dependency>
</pre>
@@ -1927,7 +1988,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 />
@@ -2010,9 +2075,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>
@@ -2054,8 +2119,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 />
@@ -2084,8 +2155,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>
@@ -2130,19 +2201,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 />
@@ -2185,24 +2267,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>
@@ -2289,25 +2371,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>
@@ -2472,7 +2558,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 />
@@ -2738,8 +2830,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>
@@ -2815,24 +2908,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>
@@ -2944,9 +3037,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 />
@@ -3011,7 +3104,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/test-aggregate-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/test-aggregate-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/test-aggregate-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:test-aggregate"></a>javadoc:test-aggregate</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:test-aggregate</p>
+<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6.1:test-aggregate</p>
<p><strong>Description</strong>:</p>
<div>Generates documentation for the <code>Java Test code</code> in an
<b>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>
@@ -336,7 +336,7 @@ d</a>. <br />
<td><code>2.5</code></td>
<td>Specifies the destination directory where test Javadoc saves the
generated HTML files.<br />
-</td>
+<strong>Default value is</strong>: <code>${project.reporting.outputDirectory}/testapidocs</code>.</td>
</tr>
</table>
</div>
@@ -360,7 +360,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>
@@ -392,7 +395,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 />
@@ -440,7 +446,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>
@@ -471,15 +477,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>
@@ -520,8 +529,8 @@ i.e.:
<pre>
<dependency>
-<groupId>commons-lang</groupId>
-<artifactId>commons-lang</artifactId>
+ <groupId>commons-lang</groupId>
+ <artifactId>commons-lang</artifactId>
</dependency>
</pre>
@@ -563,7 +572,11 @@ docencoding</a>.<br />
<tr class="a"><td><strong><a href="#docfilessubdirs">docfilessubdirs</a></strong></td>
<td><code>boolean</code></td>
<td><code>2.5</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 />
@@ -641,9 +654,9 @@ Javadoc</a>. <br />
<td><code>2.5</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 />
@@ -680,8 +693,14 @@ reverted in 2.5. <br />
<td><code>2.5</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 />
@@ -708,8 +727,8 @@ Java 1.4</a>.<br />
<td><code>String</code></td>
<td><code>2.5</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 />
@@ -741,19 +760,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 />
@@ -794,24 +824,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>
@@ -884,25 +914,29 @@ Java 5.0</a>. <br />
<td><code>2.5</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 />
@@ -965,7 +999,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>
@@ -1052,7 +1087,13 @@ Standard Doclet undocumented option. <br
<td><code>String</code></td>
<td><code>2.5</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 />
@@ -1272,8 +1313,9 @@ Java 1.4</a>.<br />
<td><code>String</code></td>
<td><code>2.5</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 />
@@ -1343,24 +1385,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>
@@ -1467,9 +1509,9 @@ Javadoc</a>. <br />
<td><code>String</code></td>
<td><code>2.5</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 />
@@ -1532,7 +1574,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 />
@@ -1542,7 +1597,9 @@ See <a href="./apidocs/org/apache/maven/
<tr class="b"><td><strong><a href="#testDescription">testDescription</a></strong></td>
<td><code>String</code></td>
<td><code>2.5</code></td>
-<td>The description of the Test Javadoc report.<br />
+<td>The description of the Test Javadoc report to be displayed in the
+Maven Generated Reports page (i.e.
+<code>project-reports.html</code>).<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#testDoctitle">testDoctitle</a></strong></td>
@@ -1560,13 +1617,19 @@ doctitle</a>. <br />
<td><code>File</code></td>
<td><code>2.5</code></td>
<td>Specifies the Test Javadoc resources directory to be included in
-the Javadoc (i.e. package.html, images...).<br />
+the Javadoc (i.e. package.html, images...). <br />
+
+Could be used in addition of <code>docfilessubdirs</code>
+parameter. <br />
+
+See <a href="#docfilessubdirs">docfilessubdirs</a>.<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#testName">testName</a></strong></td>
<td><code>String</code></td>
<td><code>2.5</code></td>
-<td>The name of the Test Javadoc report.<br />
+<td>The name of the Test 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="#testOverview">testOverview</a></strong></td>
@@ -1576,6 +1639,7 @@ the Javadoc (i.e. package.html, images..
overview documentation from the "source" file specified by
path/filename and place it on the Overview page
(overview-summary.html). <br />
+<b>Note</b>: could be in conflict with <nooverview/>. <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#overview" class="externalLink">
overview</a>. <br />
@@ -1681,7 +1745,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>
@@ -1720,7 +1787,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 />
@@ -1773,7 +1843,7 @@ bottom</a>. <br />
<li><strong>Since</strong>: <code>2.5</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>
@@ -1806,8 +1876,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>
@@ -1816,7 +1888,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>
@@ -1862,8 +1935,8 @@ i.e.:
<pre>
<dependency>
-<groupId>commons-lang</groupId>
-<artifactId>commons-lang</artifactId>
+ <groupId>commons-lang</groupId>
+ <artifactId>commons-lang</artifactId>
</dependency>
</pre>
@@ -1911,7 +1984,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 />
@@ -1994,9 +2071,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>
@@ -2038,8 +2115,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 />
@@ -2068,8 +2151,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>
@@ -2105,19 +2188,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 />
@@ -2160,24 +2254,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>
@@ -2257,25 +2351,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>
@@ -2345,7 +2443,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>
@@ -2447,7 +2546,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 />
@@ -2636,7 +2741,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.5</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
-<li><strong>Expression</strong>: <code>${project.reporting.outputDirectory}/testapidocs</code></li>
+<li><strong>Expression</strong>: <code>${reportTestOutputDirectory}</code></li>
+<li><strong>Default</strong>: <code>${project.reporting.outputDirectory}/testapidocs</code></li>
</ul>
<hr />
<p><strong><a name="resourcesArtifacts">resourcesArtifacts</a>:</strong></p>
@@ -2722,8 +2828,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>
@@ -2799,24 +2906,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>
@@ -2928,9 +3035,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 />
@@ -2995,7 +3102,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 />
@@ -3006,7 +3126,9 @@ See <a href="./apidocs/org/apache/maven/
</ul>
<hr />
<p><strong><a name="testDescription">testDescription</a>:</strong></p>
-<div>The description of the Test Javadoc report.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<div>The description of the Test 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.5</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${testDescription}</code></li>
@@ -3027,14 +3149,20 @@ doctitle</a>. <br />
<hr />
<p><strong><a name="testJavadocDirectory">testJavadocDirectory</a>:</strong></p>
<div>Specifies the Test Javadoc resources directory to be included in
-the Javadoc (i.e. package.html, images...).</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+the Javadoc (i.e. package.html, images...). <br />
+
+Could be used in addition of <code>docfilessubdirs</code>
+parameter. <br />
+
+See <a href="#docfilessubdirs">docfilessubdirs</a>.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Since</strong>: <code>2.5</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${basedir}/src/test/javadoc</code></li>
</ul>
<hr />
<p><strong><a name="testName">testName</a>:</strong></p>
-<div>The name of the Test Javadoc report.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<div>The name of the Test 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.5</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${testName}</code></li>
@@ -3045,6 +3173,7 @@ the Javadoc (i.e. package.html, images..
overview documentation from the "source" file specified by
path/filename and place it on the Overview page
(overview-summary.html). <br />
+<b>Note</b>: could be in conflict with <nooverview/>. <br />
See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#overview" class="externalLink">
overview</a>. <br />
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/test-fix-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/test-fix-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/test-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:test-fix"></a>javadoc:test-fix</h2>
<p><strong>Full name</strong>:</p>
-<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6:test-fix</p>
+<p>org.apache.maven.plugins:maven-javadoc-plugin:2.6.1:test-fix</p>
<p><strong>Description</strong>:</p>
<div>Fix Javadoc documentation and tags for the <code>Test 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">