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 [16/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/examples/aggregate.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/aggregate.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/aggregate.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/>
@@ -318,17 +318,17 @@ Project
</pre>
</div>
<div class="section"><h3>Using The <aggregate/> Parameter (<b>deprecated</b>)</h3>
-<p><b>Note</b>: <aggregate/> parameter is <b>deprecated</b> since 2.5. Please use the <tt>aggregate</tt> goal instead of.</p>
-<p>The <aggregate/> parameter can be used to generate javadocs for multi-module projects. It gives the option to generate one javadoc report for the entire project (all modules) or generate one javadoc report for each module.</p>
+<p><b>Note</b>: <a href="../javadoc-mojo.html#aggregate"><aggregate/></a> parameter is <b>deprecated</b> since 2.5. Please use the <tt>aggregate</tt> goal instead of.</p>
+<p>The <a href="../javadoc-mojo.html#aggregate"><aggregate/></a> parameter can be used to generate javadocs for multi-module projects. It gives the option to generate one javadoc report for the entire project (all modules) or generate one javadoc report for each module.</p>
<p>When you execute javadoc:javadoc from Project directory with aggregate set to <b>true</b>, a javadoc report will be created in the target directory of Project with all the javadocs of Project's modules included. If aggregate is set to <b>false</b> (default), a javadoc report for Module1 will be generated in the target directory of Module1, a javadoc report for Module2 will be generated in the target directory of Module2, and a javadoc report for Module3 will be generated in the target directory of Module3.</p>
<div class="source"><pre><project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
...
<aggregate>true</aggregate>
@@ -337,14 +337,48 @@ Project
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
</pre>
</div>
</div>
<div class="section"><h3>Using The <tt>aggregate</tt> Goals</h3>
-<p>The <aggregate/> parameter doesn't include generate source directories defined using the <a href="http://mojo.codehaus.org/build-helper-maven-plugin/add-source-mojo.html" class="externalLink">build-helper:add-source</a>. In this case, you need to use the <tt>aggregate</tt> goal and <tt>test-aggregate</tt> goals. You could also define several <reportSet/> like the following:</p>
+<p>The <a href="../javadoc-mojo.html#aggregate"><aggregate/></a> parameter doesn't include generate source directories defined using the <a href="http://mojo.codehaus.org/build-helper-maven-plugin/add-source-mojo.html" class="externalLink">build-helper:add-source</a>. In this case, you need to use the <tt>aggregate</tt> goal and <tt>test-aggregate</tt> goals. You could define these goals in the <build/> element (using the <execution/> tag) or <reporting/> element (using the <reportSet/> tag) as shown below. For more information, refer to the <a href="./selective-javadocs-report.html">Selective Javadocs Reports page</a>.</p>
+<div class="source"><pre><project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
+ <configuration>
+ <!-- Default configuration for all reports -->
+ ...
+ </configuration>
+ <executions>
+ <execution>
+ <id>aggregate</id>
+ <goals>
+ <goal>aggregate</goal>
+ </goals>
+ <phase>site</phase>
+ <configuration>
+ <!-- Specific configuration for the aggregate report -->
+ ...
+ </configuration>
+ </execution>
+ ...
+ </executions>
+ </plugin>
+ ...
+ </plugins>
+ </build>
+ ...
+</project>
+</pre>
+</div>
<div class="source"><pre>
<project>
...
@@ -353,11 +387,16 @@ Project
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
+ <configuration>
+ <!-- Default configuration for all reports -->
+ ...
+ </configuration>
<reportSets>
<reportSet>
<id>non-aggregate</id>
<configuration>
+ <!-- Specific configuration for the non aggregate report -->
...
</configuration>
<reports>
@@ -367,14 +406,17 @@ Project
<reportSet>
<id>aggregate</id>
<configuration>
+ <!-- Specific configuration for the aggregate report -->
...
</configuration>
<reports>
<report>aggregate</report>
</reports>
</reportSet>
+ ...
</reportSets>
</plugin>
+ ...
</plugins>
</reporting>
...
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/alternate-doclet.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/alternate-doclet.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/alternate-doclet.html Sun Aug 19 17:31:42 2012
@@ -75,8 +75,8 @@ Maria Odea Ching" />
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -305,93 +305,93 @@ Maria Odea Ching" />
<div id="contentBox">
<div class="section"><h2>Using Alternate Doclet</h2>
<p>To generate output from an alternate doclet, add configuration similar to the following to your POM.</p>
-<p>In this example, the doclet is UmlGraph. UmlGraph allows the declarative specification and drawing of UML class and sequence diagrams. For more information about UmlGraph, please refer to <a href="http://www.umlgraph.org/" class="externalLink">http://www.umlgraph.org/</a>.</p>
+<p>In this example, the doclet is UmlGraph (<a href="http://www.umlgraph.org/" class="externalLink">http://www.umlgraph.org/</a>). UmlGraph allows the declarative specification and drawing of UML class and sequence diagrams.</p>
+<p><b>Note about UmlGraph</b>: You must have the Graphviz binary in your PATH, or the images will not be generated. For more information about Graphviz, please refer to <a href="http://www.graphviz.org/" class="externalLink">http://www.graphviz.org/</a>.</p>
<div class="source"><pre><project>
- ...
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
- <configuration>
- <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
+ ...
+ <reporting> (or <build>)
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
+ <configuration>
+ <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
- <!-- <docletPath>/path/to/UmlGraph.jar</docletPath> -->
- <docletArtifact>
- <groupId>org.umlgraph</groupId>
- <artifactId>doclet</artifactId>
- <version>5.1</version>
- </docletArtifact>
- <additionalparam>-views</additionalparam>
- <useStandardDocletOptions>true</useStandardDocletOptions>
- </configuration>
- </plugin>
- ...
- </plugins>
- </reporting>
- ...
+ <!-- <docletPath>/path/to/UmlGraph.jar</docletPath> -->
+ <docletArtifact>
+ <groupId>org.umlgraph</groupId>
+ <artifactId>doclet</artifactId>
+ <version>5.1</version>
+ </docletArtifact>
+ <additionalparam>-views</additionalparam>
+ <useStandardDocletOptions>true</useStandardDocletOptions>
+ </configuration>
+ </plugin>
+ ...
+ </plugins>
+ </reporting> (or </build>)
+ ...
</project>
</pre>
</div>
<p><b>Note</b>:</p>
-<ul><li><additionalparam/> is used to set additional parameters on the command line, specifically for doclet options.</li>
-<li><useStandardDocletOptions/> uses the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#standard" class="externalLink">options provided by the Standard Doclet</a>.</li>
-<li>If you need more artifacts in the docletpath, you could use <docletArtifacts/>.</li>
+<ul><li><a href="../javadoc-mojo.html#additionalparam"><additionalparam/></a> parameter could be used to set additional parameters on the command line, specifically for doclet options.</li>
+<li><a href="../javadoc-mojo.html#useStandardDocletOptions"><useStandardDocletOptions/></a> parameter could be used to specify that the given doclet should use the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#standard" class="externalLink">options provided by the Standard Doclet</a>.</li>
+<li>If you need more artifacts in the docletpath, you could use the <a href="../javadoc-mojo.html#docletArtifacts"><docletArtifacts/></a> parameter.</li>
</ul>
<p>After executing <tt>mvn site</tt>, you will see that a UML graph (.dot file) will be generated in the destination directory.</p>
-<p><b>Note about UmlGraph</b>: You must have the Graphviz binary in your PATH, or the images will not be generated. For more information about Graphviz, please refer to <a href="http://www.graphviz.org/" class="externalLink">http://www.graphviz.org/</a>.</p>
</div>
<div class="section"><h2>Using Alternate Doclet In Addition To The Javadoc Doclet</h2>
<p>To generate output from an alternate doclet in addition to the normal HTML Javadoc doclet, add configuration similar to the following to your POM.</p>
-<p>In this example, the doclet is Sun DocCheck. The Sun Doc Check Doclet is an extension to the Javadoc tool. It runs on source code and reviews documentation comments, generating an HTML report that identifies empty comments and other ommissions and irregularities in the documentation comments. For more information about Sun DocCheck, please refer to <a href="http://java.sun.com/j2se/javadoc/doccheck/" class="externalLink">http://java.sun.com/j2se/javadoc/doccheck/</a>.</p>
+<p>In this example, the doclet is Sun DocCheck (<a href="http://java.sun.com/j2se/javadoc/doccheck/" class="externalLink">http://java.sun.com/j2se/javadoc/doccheck/</a>). The Sun Doc Check Doclet is an extension to the Javadoc tool. It runs on source code and reviews documentation comments, generating an HTML report that identifies empty comments and other ommissions and irregularities in the documentation comments.</p>
<div class="source"><pre><project>
- ...
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
- <reportSets>
- <reportSet>
- <id>html</id>
- <reports>
- <report>javadoc</report>
- </reports>
- </reportSet>
- <reportSet>
- <id>doccheck</id>
- <configuration>
- <doclet>com.sun.tools.doclets.doccheck.DocCheck</doclet>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
+ <reportSets>
+ <reportSet>
+ <id>html</id>
+ <reports>
+ <report>javadoc</report>
+ </reports>
+ </reportSet>
+ <reportSet>
+ <id>doccheck</id>
+ <configuration>
+ <doclet>com.sun.tools.doclets.doccheck.DocCheck</doclet>
- <!-- <docletPath>/path/to/doccheck.jar</docletPath> -->
- <docletArtifact>
- <groupId>com.sun.tools.doclets</groupId>
- <artifactId>doccheck</artifactId>
- <version>1.2b2</version>
- </docletArtifact>
- <additionalparam>
+ <!-- <docletPath>/path/to/doccheck.jar</docletPath> -->
+ <docletArtifact>
+ <groupId>com.sun.tools.doclets</groupId>
+ <artifactId>doccheck</artifactId>
+ <version>1.2b2</version>
+ </docletArtifact>
+ <additionalparam>
-d ${project.build.directory}/site/doccheck
- </additionalparam>
+ </additionalparam>
- <!-- Other dir than apidocs -->
- <destDir>doccheck</destDir>
+ <!-- Other dir than apidocs -->
+ <destDir>doccheck</destDir>
- <!-- For the project-reports page-->
- <name>DocCheck</name>
- <description>DocCheck documentation.</description>
- </configuration>
- <reports>
- <report>javadoc</report>
- </reports>
- </reportSet>
- </reportSets>
- </plugin>
- ...
- </plugins>
- </reporting>
- ...
+ <!-- For the project-reports page-->
+ <name>DocCheck</name>
+ <description>DocCheck documentation.</description>
+ </configuration>
+ <reports>
+ <report>javadoc</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ ...
+ </plugins>
+ </reporting>
+ ...
</project>
</pre>
</div>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/alternate-javadoc-tool.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/alternate-javadoc-tool.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/alternate-javadoc-tool.html Sun Aug 19 17:31:42 2012
@@ -74,8 +74,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -305,48 +305,49 @@
<div class="section"><h2>Using Alternate Javadoc Tool</h2>
<div class="section"><h3>Using Alternate Javadoc Executable</h3>
<p>By default, the Maven Javadoc Plugin tries to auto-detect the Javadoc Tool executable from the Java property <i>java.home</i> or from the environment variable <i>JAVA_HOME</i>.</p>
-<p>You could also specify the executable of the Javadoc Tool to use. For example:</p>
+<p>You could also specify the executable of the Javadoc Tool to use with the <a href="../javadoc-mojo.html#javadocExecutable"><javadocExecutable/></a> parameter. For example:</p>
<div class="source"><pre><project>
- ...
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
- <configuration>
- <javadocExecutable>C:\jdk1.6.0\bin\javadoc.exe</javadocExecutable>
- ...
- </configuration>
- </plugin>
- ...
- </plugins>
- </reporting>
- ...
+ ...
+ <reporting> (or <build>)
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
+ <configuration>
+ <javadocExecutable>C:\jdk1.6.0\bin\javadoc.exe</javadocExecutable>
+ ...
+ </configuration>
+ </plugin>
+ ...
+ </plugins>
+ </reporting> (or </build>)
+ ...
</project>
</pre>
</div>
+<p><b>IMPORTANT NOTE</b>: by using <a href="../javadoc-mojo.html#javadocExecutable"><javadocExecutable/></a> parameter, the build will be plateform dependent! A good practice is to define an environnement variable (i.e. JAVA_1.6_HOME), so you could specify it: (i.e. <javadocExecutable>${env.JAVA_1.6_HOME}/bin/javadoc</javadocExecutable>). An other ways is to define a POM property using <project><properties/></project>.</p>
</div>
<div class="section"><h3>Using Alternate Javadoc Version</h3>
<p>In the same way, the Maven Javadoc Plugin tries to auto-detect the Javadoc Tool version by calling <i>javadoc -J-fullversion</i>.</p>
<p>You could also specify the version of the Javadoc Tool executable. For example:</p>
<div class="source"><pre><project>
- ...
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
- <configuration>
- <javadocVersion>1.5</javadocVersion>
- ...
- </configuration>
- </plugin>
- ...
- </plugins>
- </reporting>
- ...
+ ...
+ <reporting> (or <build>)
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
+ <configuration>
+ <javadocVersion>1.5</javadocVersion>
+ ...
+ </configuration>
+ </plugin>
+ ...
+ </plugins>
+ </reporting> (or </build>)
+ ...
</project>
</pre>
</div>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/exclude-package-names.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/exclude-package-names.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/exclude-package-names.html Sun Aug 19 17:31:42 2012
@@ -74,8 +74,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -303,24 +303,64 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Excluding Packages</h2>
-<p>To exclude specific packages from the javadoc, use <excludePackageNames> as shown below. The parameter accepts wildcard (*) characters in its value but the wildcards should either be at the start or the end of the package name. If more than one package is to be excluded, each package name must be separated either with a ':', ',' or ';'.</p>
+<p>To exclude specific packages, use <a href="../javadoc-mojo.html#excludePackageNames"><excludePackageNames/></a> parameter as shown below. The parameter accepts wildcard (*) characters in its value but the wildcards should either be at the start or the end of the package name. If more than one package is to be excluded, each package name must be separated either with a colon (':'), a comma (',') or a semicolon (';'). (similar to the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#exclude" class="externalLink">Javadoc Tool</a>)</p>
+<p>For instance, with the following packages:</p>
+<div class="source"><pre>com.mycompany.myapp
+com.mycompany.myapp.package1
+com.mycompany.myapp.package1.subpackage1
+com.mycompany.myapp.package1.subpackage2
+com.mycompany.myapp.package1.subpackage3
+com.mycompany.myapp.package1.util
+com.mycompany.myapp.package2
+com.mycompany.myapp.package2.subpackage4
+com.mycompany.myapp.package2.subpackage5
+com.mycompany.myapp.package2.util
+com.mycompany.myapp.package3
+com.mycompany.myapp.package3.subpackage6
+com.mycompany.myapp.package3.subpackage6.subsubpackage1
+com.mycompany.myapp.package3.subpackage6.subsubpackage2
+com.mycompany.myapp.package3.subpackage7
+com.mycompany.myapp.package3.util
+</pre>
+</div>
+<p>You could have the following configuration:</p>
<div class="source"><pre><project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
- ...
- <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
+ <!--
+ Exclude packages:
+ com.mycompany.myapp.package1.subpackage1
+ com.mycompany.myapp.package1.subpackage2
+ com.mycompany.myapp.package1.subpackage3
+ com.mycompany.myapp.package1.util
+ com.mycompany.myapp.package2
+ com.mycompany.myapp.package2.subpackage4
+ com.mycompany.myapp.package2.subpackage5
+ com.mycompany.myapp.package2.util
+ com.mycompany.myapp.package3.util
+ BUT include the packages:
+ com.mycompany.myapp
+ com.mycompany.myapp.package1
+ com.mycompany.myapp.package3
+ com.mycompany.myapp.package3.subpackage6
+ com.mycompany.myapp.package3.subpackage6.subsubpackage1
+ com.mycompany.myapp.package3.subpackage6.subsubpackage2
+ com.mycompany.myapp.package3.subpackage7
+ -->
+ <excludePackageNames>com.mycompany.myapp.package1.*:com.mycompany.myapp.package2:*.util.*</excludePackageNames>
...
</configuration>
</plugin>
+ ...
</plugins>
...
- </reporting>
+ </reporting> (or <build>)
...
</project>
</pre>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/fix-javadocs.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/fix-javadocs.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/fix-javadocs.html Sun Aug 19 17:31:42 2012
@@ -74,8 +74,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -307,9 +307,9 @@
<p>You need to call <i>mvn javadoc:fix</i> to fix main Java source files (i.e. inside src/main/java directory) or <i>mvn javadoc:test-fix</i> to fix test Java source files (i.e. inside src/test/java directory).</p>
<p><b>Important Note</b>: Since the changes are done <b>directly</b> in the source code, we recommend <b>strongly</b> the use of a SCM, so you could always do a revert if a problem occurs. You could always add <tt>-DoutputDirectory=/path/to/dir</tt> to specify a target directory where classes will be generated.</p>
<div class="section"><h3>Features Summary</h3>
-<p>The user could skip the class/field/method Javadoc fixing using specific parameters, i.e. <a href="../fix-mojo.html#fixClassComment">fixClassComment</a>. Also, the user could specify a <a href="../fix-mojo.html#level">level</a>, i.e. public, to fix only class/field/method with the given level.</p>
-<p>These goals could fix dynamically all Javadoc tags (by default, see <a href="../fix-mojo.html#fixTags">fixTags</a>) or selective tags like author, version... Also, the user could specify default value for some tags, i.e. <a href="../fix-mojo.html#defaultAuthor">defaultAuthor</a>.</p>
-<p>The <i>javadoc:fix</i> goal could use <a href="http://clirr.sourceforge.net/" class="externalLink">Clirr</a> via the <a href="http://mojo.codehaus.org/clirr-maven-plugin/" class="externalLink">clirr-maven-plugin</a>, a tool that checks Java libraries for binary and source compatibility with older releases. So, the <i>@since</i> tags will be dynamically added for the current project version. You need to add the <i>comparisonVersion</i> parameter (see below).</p>
+<p>The user could skip the class/field/method Javadoc fixing using specific parameters, i.e. <a href="../fix-mojo.html#fixClassComment"><fixClassComment/></a>. Also, the user could specify a <a href="../fix-mojo.html#level"><level/></a>, i.e. public, to fix only class/field/method with the given level.</p>
+<p>These goals could fix dynamically all Javadoc tags (by default, see <a href="../fix-mojo.html#fixTags"><fixTags/></a>) or selective tags like author, version... Also, the user could specify default value for some tags, i.e. <a href="../fix-mojo.html#defaultAuthor"><defaultAuthor/></a>.</p>
+<p>The <i>javadoc:fix</i> goal could use Clirr (<a href="http://clirr.sourceforge.net" class="externalLink"></a> via the <a href="http://mojo.codehaus.org/clirr-maven-plugin/" class="externalLink">clirr-maven-plugin</a>, a tool that checks Java libraries for binary and source compatibility with older releases. So, the <i>@since</i> tags will be dynamically added for the current project version. You need to add the <i>comparisonVersion</i> parameter (see below).</p>
<p>Finally, the user could process specific Java files using the <a href="../fix-mojo.html#includes">includes</a>/<a href="../fix-mojo.html#excludes">excludes</a> parameters.</p>
<div class="section"><h4>Current limitations</h4>
<p>The <i>fix</i> and <i>test-fix</i> goals use intensively <a href="http://qdox.codehaus.org/" class="externalLink">Qdox</a> to extract class/interface/method Javadoc from source files. Unfortunately, Qdox has <a href="http://jira.codehaus.org/browse/QDOX" class="externalLink">some known issues</a>.</p>
@@ -354,12 +354,13 @@ y
<div class="section"><h4>Using another Clirr version</h4>
<p>By default, the <i>fix</i> and <i>test-fix</i> goals use the <a href="http://mojo.codehaus.org/clirr-maven-plugin/" class="externalLink">clirr-maven-plugin</a>, version <tt>2.2.2</tt>. To use another version, you need to add a dependency in the Javadoc plugin, similar to the following:</p>
<div class="source"><pre><project>
+ ...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
...
</configuration>
@@ -370,10 +371,12 @@ y
<version>2.3-SNAPSHOT</version>
</dependency>
</dependencies>
- ...
</plugin>
+ ...
</plugins>
+ ...
</build>
+ ...
</project>
</pre>
</div>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/group-configuration.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/group-configuration.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/group-configuration.html Sun Aug 19 17:31:42 2012
@@ -75,8 +75,8 @@ Maria Odea Ching" />
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -304,33 +304,116 @@ Maria Odea Ching" />
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Grouping Packages</h2>
-<p>To set a grouping for different packages, use the <groups/> configuration in your pom:</p>
+<p>To set a grouping for different packages, use the <a href="../javadoc-mojo.html#groups"><groups/></a> parameter as shown below. Each group will be consist of a <title/> and a <packages/> (as String). The <packages/> element supports wildcard (*) to allow subpackages. If more than one package is to be included, each package name must be separated colon (:) separated (similar to the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#group" class="externalLink">Javadoc Tool</a>).</p>
+<p>For instance, with the following packages:</p>
+<div class="source"><pre>com.mycompany.myapp
+com.mycompany.myapp.package1
+com.mycompany.myapp.package1.subpackage1
+com.mycompany.myapp.package1.subpackage2
+com.mycompany.myapp.package1.subpackage3
+com.mycompany.myapp.package1.util
+com.mycompany.myapp.package2
+com.mycompany.myapp.package2.subpackage4
+com.mycompany.myapp.package2.subpackage5
+com.mycompany.myapp.package2.util
+</pre>
+</div>
+<p>You could have the following configuration:</p>
<div class="source"><pre><project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
- ...
<groups>
<group>
- <title>Core Packages</title>
- <packages>org.apache.maven.plugin.javadoc.test1</packages>
+ <title>Example 1 - Group Packages</title>
+ <!--
+ Include packages:
+ com.mycompany.myapp
+ com.mycompany.myapp.package1
+ BUT exclude all subpackages
+ -->
+ <packages>com.mycompany.myapp:com.mycompany.myapp.package1</packages>
+ </group>
+ <group>
+ <title>Example 2 - Group Packages</title>
+ <!--
+ Include packages:
+ com.mycompany.myapp.package1.subpackage1
+ com.mycompany.myapp.package1.subpackage2
+ com.mycompany.myapp.package1.subpackage3
+ com.mycompany.myapp.package1.util
+ BUT exclude the root package:
+ com.mycompany.myapp.package1
+ -->
+ <packages>com.mycompany.myapp.package1.*</packages>
+ </group>
+ <group>
+ <title>Example 3 - Group Packages</title>
+ <!--
+ Include packages:
+ com.mycompany.myapp.package1
+ com.mycompany.myapp.package1.subpackage1
+ com.mycompany.myapp.package1.subpackage2
+ com.mycompany.myapp.package1.subpackage3
+ com.mycompany.myapp.package1.util
+ -->
+ <packages>com.mycompany.myapp.package1*</packages>
+ </group>
+ <group>
+ <title>Example 4 - Group Packages</title>
+ <!--
+ Include packages:
+ com.mycompany.myapp.package1
+ com.mycompany.myapp.package1.subpackage1
+ com.mycompany.myapp.package1.subpackage2
+ com.mycompany.myapp.package1.subpackage3
+ com.mycompany.myapp.package1.util
+ com.mycompany.myapp.package2
+ com.mycompany.myapp.package2.subpackage4
+ com.mycompany.myapp.package2.subpackage5
+ com.mycompany.myapp.package2.util
+ -->
+ <packages>com.mycompany.myapp.package*</packages>
+ </group>
+ <group>
+ <title>Example 5 - Group Packages</title>
+ <!--
+ Include packages:
+ com.mycompany.myapp.package1.subpackage1
+ com.mycompany.myapp.package1.subpackage2
+ com.mycompany.myapp.package1.subpackage3
+ com.mycompany.myapp.package1.util
+ com.mycompany.myapp.package2.subpackage4
+ com.mycompany.myapp.package2.subpackage5
+ com.mycompany.myapp.package2.util
+ BUT exclude the root packages:
+ com.mycompany.myapp.package1
+ com.mycompany.myapp.package2
+ -->
+ <packages>com.mycompany.myapp.package1.*:com.mycompany.myapp.package2.*</packages>
</group>
<group>
- <title>Extension Packages</title>
- <packages>org.apache.maven.plugin.javadoc.test2</packages>
+ <title>Example 6 - Group Packages</title>
+ <!--
+ Include nothing.
+ The packages com.mycompany.myapp.package1.util and com.mycompany.myapp.package2.util
+ will be in "Other Packages" group
+ -->
+ <packages>*.util.*</packages>
</group>
</groups>
...
</configuration>
</plugin>
+ ...
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
</pre>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/help-configuration.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/help-configuration.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/help-configuration.html Sun Aug 19 17:31:42 2012
@@ -74,8 +74,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -303,14 +303,15 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Configuring Help File</h2>
-<p>If a custom <helpfile/> parameter is specified, you will be able to use it:</p>
-<ul><li>if <helpfile/> is a given file, you could use an absolute or a relative path, for instance:<div class="source"><pre><project>
+<p>If a custom <a href="../javadoc-mojo.html#helpfile"><helpfile/></a> parameter is specified, you will be able to use it:</p>
+<ul><li>if <a href="../javadoc-mojo.html#helpfile"><helpfile/></a> is a given file, you could use an absolute or a relative path, for instance:<div class="source"><pre><project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
<configuration>
<helpfile>${basedir}/path/to/your/helpfile</helpfile>
...
@@ -318,34 +319,20 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
</pre>
</div>
</li>
-<li>since 2.6, <helpfile/> could be a resource in your project directory, i.e. <tt>src/main/java</tt>, <tt>src/main/resources</tt> or <tt>src/main/javadoc</tt>, for instance:<div class="source"><pre><project>
+<li>since 2.6, <a href="../javadoc-mojo.html#helpfile"><helpfile/></a> could be a resource in your project directory, i.e. <tt>src/main/java</tt>, <tt>src/main/resources</tt> or <tt>src/main/javadoc</tt>, for instance:<div class="source"><pre><project>
...
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <helpfile>path/to/your/resource/help-doc.html</helpfile>
- ...
- </configuration>
- </plugin>
- </plugins>
- ...
- </build>
- ...
- <!-- Or the following
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
<configuration>
<helpfile>path/to/your/resource/help-doc.html</helpfile>
...
@@ -353,20 +340,20 @@
</plugin>
</plugins>
...
- </reporting>
- -->
+ </reporting> (or </build>)
...
</project>
</pre>
</div>
</li>
-<li>since 2.6, <helpfile/> could be a resource in the Javadoc plugin dependencies, for instance:<div class="source"><pre><project>
+<li>since 2.6, <a href="../javadoc-mojo.html#helpfile"><helpfile/></a> could be a resource in the Javadoc plugin dependencies, for instance:<div class="source"><pre><project>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
<configuration>
<helpfile>path/to/your/resource/help-doc.html</helpfile>
</configuration>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/javadoc-resources.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/javadoc-resources.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/javadoc-resources.html Sun Aug 19 17:31:42 2012
@@ -74,8 +74,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -303,26 +303,27 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Using Javadoc Resources</h2>
-<p>The <javadocDirectory/> parameter can be used to include Javadoc resources like HTML or images. By default, all javadoc resources are in <i>${basedir}/src/main/javadoc</i> directory.</p>
+<p>The <a href="../javadoc-mojo.html#javadocDirectory"><javadocDirectory/></a> parameter can be used to include Javadoc resources like HTML or images. By default, all javadoc resources are in <i>${basedir}/src/main/javadoc</i> directory.</p>
<p>Here is a typical set of resources files used by the Maven Javadoc plugin:</p>
<div class="source"><pre>
yourproject
|-- src
- |-- main
- |-- java
- | |-- org
- | |-- apache
- | |-- myapp
- | `-- App.java
- | `-- package-info.java
- |-- javadoc
- `-- overview.html
- |-- org
- |-- apache
- |-- myapp
- `-- package.html
- |-- doc-files
- `-- app.png
+ |-- main
+ |-- java
+ | |-- org
+ | |-- apache
+ | |-- myapp
+ | `-- App.java
+ | `-- package-info.java
+ |-- javadoc
+ `-- overview.html
+ |-resources
+ |-- org
+ |-- apache
+ |-- myapp
+ `-- package.html
+ |-- doc-files
+ `-- app.png
</pre>
</div>
<div class="section"><h3>Overview Comment File: <i>overview.html</i></h3>
@@ -340,7 +341,7 @@ yourproject
</HTML>
</pre>
</div>
-<p>By default, the Javadoc Plugin includes the <i>${basedir}/src/main/javadoc/overview.html</i> if it exists. You could also specify a specific <i>overview</i> file with the <overview/> parameter, for instance:</p>
+<p>By default, the Javadoc Plugin includes the <i>${basedir}/src/main/javadoc/overview.html</i> if it exists. You could also specify a specific <i>overview</i> file with the <a href="../javadoc-mojo.html#overview"><overview/></a> parameter, for instance:</p>
<div class="source"><pre><project>
...
<reporting>
@@ -348,7 +349,7 @@ yourproject
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
...
<overview>${basedir}/overview.html</overview>
@@ -366,7 +367,7 @@ yourproject
<div class="section"><h3>Package Comment File: <i>package.html</i></h3>
<p>These contain package comments. The <i>package.html</i> is a brief summary of each packages in the list of all packages.</p>
<p>For more information, see <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#packagecomment" class="externalLink"> javadoc - The Java API Documentation Generator, Package Comment Files</a> and <a href="http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#packagecomments" class="externalLink"> How to Write Doc Comments for the Javadoc Tool, Package-Level Comments</a>.</p>
-<p>Here is an example of a <i>package.html</i> file, located in <i>${basedir}/src/main/javadoc/org/apache/test/package.html</i>:</p>
+<p>Here is an example of a <i>package.html</i> file, located in <i>${basedir}/src/main/javadoc/org/apache/myapp/package.html</i>:</p>
<div class="source"><pre><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
@@ -381,20 +382,21 @@ yourproject
</div>
<p><b>Note</b>: With Javadoc 5.0, this file becomes <i>package-info.java</i> and is preferred over <i>package.html</i>.</p>
<p>For more information, see <a href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#packagecomment" class="externalLink"> javadoc - The Java API Documentation Generator, Package Comment Files</a>.</p>
-<p>Here is an example of a <i>package-info.java</i> file, located in <i>${basedir}/src/main/java/org/apache/test/package-info.java</i>:</p>
+<p>Here is an example of a <i>package-info.java</i> file, located in <i>${basedir}/src/main/java/org/apache/myapp/package-info.java</i>:</p>
<div class="source"><pre>/**
* This is the core package for the application
* @since 1.0
*/
-package org.apache.test;
+package org.apache.myapp;
</pre>
</div>
</div>
<div class="section"><h3>Miscellaneous Unprocessed Files: <i>doc-files</i></h3>
<p>These include images, sample source code, class files, applets, HTML files...</p>
-<p>For more information, see <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/javadoc.html#unprocessed" class="externalLink"> javadoc - The Java API Documentation Generator, Miscellaneous Unprocessed Files</a> and <a href="http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#images" class="externalLink"> How to Write Doc Comments for the Javadoc Tool, Including Images </a>.</p>
-<p>Here is a sample javadoc comment to use images, located in <i>${basedir}/src/main/javadoc/org/apache/test/doc-files</i> directory:</p>
-<div class="source"><pre>package org.apache.test;
+<p>For more information, see <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/javadoc.html#unprocessed" class="externalLink"> javadoc - The Java API Documentation Generator, Miscellaneous Unprocessed Files</a> and <a href="http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#images" class="externalLink">How to Write Doc Comments for the Javadoc Tool, Including Images </a>.</p>
+<p>In addition to <i>doc-files</i> directories, since 2.6.1, the specific <i>src/main/javadoc/resources</i> directory will be copied to the generated Javadoc resources directory (i.e. <i>apidocs/resources</i>). This is usefull when you want to overwite default Javadoc tool resources, like the default <i>inherit.gif</i> to one with a transparent background (See <a href="../images/inherit.gif">GIF</a> or <a href="../images/inherit.psd">PSD</a>).</p>
+<p>Here is a sample javadoc comment to use <i>app.png</i> image, located in <i>${basedir}/src/main/javadoc/org/apache/myapp/doc-files</i> directory:</p>
+<div class="source"><pre>package org.apache.myapp;
/**
* The main Class launches the application.
@@ -405,7 +407,7 @@ public class App
}
</pre>
</div>
-<p><b>Note</b>: You need to run the Javadoc Plugin with the <tt>docfilessubdirs</tt> parameter to allow the copy of unprocessed files.</p>
+<p><b>IMPORTANT NOTE</b>: To allow the copy of unprocessed files, you need to run the Javadoc Plugin with the <a href="../javadoc-mojo.html#docfilessubdirs"><docfilessubdirs/></a> parameter.</p>
</div>
</div>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/links-configuration.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/links-configuration.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/links-configuration.html Sun Aug 19 17:31:42 2012
@@ -74,8 +74,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -303,14 +303,15 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Configuring <tt>links</tt> Parameter</h2>
-<p>You could add cross reference links to external projects. For instance:</p>
+<p>You could add cross reference links to external projects using the <a href="../javadoc-mojo.html"><links/></a> parameters. For instance:</p>
<div class="source"><pre><project>
...
- <build>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
<configuration>
<links>
<link>http://commons.apache.org/dbcp/apidocs/</link>
@@ -320,13 +321,13 @@
</configuration>
</plugin>
</plugins>
- </build>
+ </reporting> (or </build>)
...
</project>
</pre>
</div>
<p><b>Important Note</b>: according the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#package-list" class="externalLink">Javadoc specifications</a>, all given links <b>should</b> have a fetchable <tt>/package-list</tt> file.</p>
-<p>Since 2.6, you could try to detect all Javadoc links for the project's dependencies. You need to use the <a href="../javadoc-mojo.html#detectLinks">detectLinks</a> parameter. All detected links are based on the default Maven conventions. For instance, if your project has a dependency to <a href="http://commons.apache.org/lang/" class="externalLink">Apache Commons Lang</a> i.e.:</p>
+<p>Since 2.6, you could try to detect all Javadoc links for the project's dependencies. You need to use the <a href="../javadoc-mojo.html#detectLinks"><detectLinks/></a> parameter. All detected links are based on the default Maven conventions. For instance, if your project has a dependency to <a href="http://commons.apache.org/lang/" class="externalLink">Apache Commons Lang</a> i.e.:</p>
<div class="source"><pre><project>
...
<dependencies>
@@ -341,18 +342,20 @@
</pre>
</div>
<p>The added Javadoc link will be <a href="http://commons.apache.org/lang/apidocs" class="externalLink">http://commons.apache.org/lang/apidocs</a>.</p>
-<p>Since 2.6, a <a href="http://java.sun.com/reference/api/index.html" class="externalLink">Javadoc API</a> link, depending the JDK version used by your project, will be added. The version of the Javadoc API is detected from the value of the <tt><a href="http://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#source" class="externalLink">source</a></tt> parameter in the <tt><a href="http://maven.apache.org/plugins/maven-compiler-plugin" class="externalLink">org.apache.maven.plugins:maven-compiler-plugin</a></tt> (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or computed via the Javadoc Tool executable. If you want to skip this link, you need to configure <a href="../javadoc-mojo.html#detectJavaApiLink">detectJavaApiLink</a> to <tt>false</tt>.</p>
-<p><b>Note</b>: if you are using an unsupported JDK like 7.0, you could add its Javadoc API url using the <a href="../javadoc-mojo.html#javaApiLinks">javaApiLinks</a> parameter, i.e.:</p>
-<div class="source"><pre> <javaApiLinks>
- ...
- <property>
- <name>api_1.7</name>
- <value>http://download.java.net/jdk7/docs/api/</value>
- </property>
- </javaApiLinks>
+<p>Since 2.6, a <a href="http://java.sun.com/reference/api/index.html" class="externalLink">Javadoc API</a> link, depending the JDK version used by your project, will be added. The version of the Javadoc API is detected from the value of the <a href="http://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#source" class="externalLink"><source/></a> parameter in the <tt><a href="http://maven.apache.org/plugins/maven-compiler-plugin" class="externalLink">org.apache.maven.plugins:maven-compiler-plugin</a></tt> (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or computed via the Javadoc Tool executable. If you want to skip this link, you need to configure <a href="../javadoc-mojo.html#detectJavaApiLink"><detectJavaApiLink/></a> to <tt>false</tt>.</p>
+<p><b>Note</b>: if you are using an unsupported JDK like 7.0, you could add its Javadoc API url using the <a href="../javadoc-mojo.html#javaApiLinks"><javaApiLinks/></a> parameter, i.e.:</p>
+<div class="source"><pre><configuration>
+ <javaApiLinks>
+ <property>
+ <name>api_1.7</name>
+ <value>http://download.java.net/jdk7/docs/api/</value>
+ </property>
+ </javaApiLinks>
+ ...
+</configuration>
</pre>
</div>
-<p>Refer to <a href="../javadoc-mojo.html#links">links</a> parameter for more information.</p>
+<p>Refer to <a href="../javadoc-mojo.html"><links/></a> parameter for more information.</p>
</div>
<div class="section"><h2>Configuring <tt>offlineLinks</tt> Parameter</h2>
<p>If your project has modules, you could add cross reference links to your modules when your goals are not aggregator goals. For instance, if your project has two modules i.e.:</p>
@@ -368,8 +371,8 @@
</div>
<p>The offlineLinks for <b>module1</b> will be <tt>/absolute/path/to/</tt><b>module2</b><tt>/target/site/apidocs</tt> and the offlineLinks for <b>module2</b> will be <tt>/absolute/path/to/</tt><b>module1</b><tt>/target/site/apidocs</tt>.</p>
<p><b>Important Note</b>: all offlinelinks are based on the ${project.url} if present.</p>
-<p>Since 2.6, you could disable the cross reference for <tt>offlineLinks</tt> using the <a href="../javadoc-mojo.html#detectOfflineLinks">detectOfflineLinks</a> parameter.</p>
-<p>Refer to <a href="../javadoc-mojo.html#offlineLinks">offlineLinks</a> parameter for more information.</p>
+<p>Since 2.6, you could disable the cross reference for <tt>offlineLinks</tt> using the <a href="../javadoc-mojo.html#detectOfflineLinks"><detectOfflineLinks/></a> parameter.</p>
+<p>Refer to <a href="../javadoc-mojo.html#offlineLinks"><offlineLinks/></a> parameter for more information.</p>
</div>
</div>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/output-configuration.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/output-configuration.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/output-configuration.html Sun Aug 19 17:31:42 2012
@@ -74,8 +74,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -311,7 +311,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
<reportOutputDirectory>${project.reporting.outputDirectory}/myoutput</reportOutputDirectory>
<destDir>myapidocs</destDir>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/selective-javadocs-report.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/selective-javadocs-report.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/selective-javadocs-report.html Sun Aug 19 17:31:42 2012
@@ -74,8 +74,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,43 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Selective Javadocs Reports</h2>
-<p>To run the Javadocs reports selectively, you need to include only the Javadocs reports that you prefer. Use "mvn site" to generate the selected reports.</p>
+<p>To run the Javadocs reports selectively, you need to include only the Javadocs reports that you prefer. As said in the <a href="../faq.html#Where_in_the_pom.xml_do_I_configure_the_Javadoc_Plugin">FAQ</a>, the configuration depends on the <build/> tag or <reporting/> tag used.</p>
+<div class="section"><h3>Using <build/> Tag</h3>
+<div class="source"><pre><project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
+ <configuration>
+ <!-- Default configuration for all reports -->
+ ...
+ </configuration>
+ <executions>
+ <execution>
+ <goals>
+ <goal>javadoc</goal>
+ <goal>test-javadoc</goal>
+ </goals>
+ <phase>site</phase>
+ <configuration>
+ <!-- Specific configuration for the given reports -->
+ ...
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project>
+</pre>
+</div>
+<p>Since the phase is <tt>site</tt>, you need to call <tt>mvn site</tt> to generate the selected reports (only main and test javadocs).</p>
+</div>
+<div class="section"><h3>Using <reporting/> Tag</h3>
<div class="source"><pre>
<project>
...
@@ -312,15 +348,31 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
+ <!-- Default configuration for all reports -->
...
</configuration>
<reportSets>
<reportSet>
+ <id>default</id>
+ <configuration>
+ <!-- Specific configuration for the given reports -->
+ ...
+ </configuration>
<reports>
<report>javadoc</report>
- <!-- <report>test-javadoc</report> -->
+ <report>test-javadoc</report>
+ </reports>
+ </reportSet>
+ <reportSet>
+ <id>aggregate</id>
+ <configuration>
+ <!-- Specific configuration for the given reports -->
+ ...
+ </configuration>
+ <reports>
+ <report>aggregate</report>
</reports>
</reportSet>
</reportSets>
@@ -331,6 +383,8 @@
</project>
</pre>
</div>
+<p>Just call <tt>mvn site</tt> to generate the selected reports (main, test and aggregate javadocs).</p>
+</div>
</div>
</div>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/stylesheet-configuration.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/stylesheet-configuration.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/stylesheet-configuration.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/>
@@ -304,15 +304,15 @@ Vincent Siveton" />
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Configuring Stylesheets</h2>
-<p>If no custom stylesheet is specified in the <stylesheetfile/> parameter, the <stylesheet/> parameter will indicate which stylesheet will be used -- the stylesheet included in the maven javadoc plugin or the default stylesheet used by the javadoc tool. <b>maven</b> value indicates the maven javadoc plugin stylesheet, while <b>java</b> value indicates the default javadoc tool stylesheet. The default is <b>java</b> value if not specified.</p>
+<p>If no custom stylesheet is specified in the <a href="../javadoc-mojo.html#stylesheetfile"><stylesheetfile/></a> parameter, the <a href="../javadoc-mojo.html#stylesheet"><stylesheet/></a> parameter will indicate which stylesheet will be used -- the stylesheet included in the maven javadoc plugin or the default stylesheet used by the javadoc tool. <b>maven</b> value indicates the maven javadoc plugin stylesheet, while <b>java</b> value indicates the default javadoc tool stylesheet. The default is <b>java</b> value if not specified.</p>
<div class="source"><pre><project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
<stylesheet>maven</stylesheet>
...
@@ -320,21 +320,22 @@ Vincent Siveton" />
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
</pre>
</div>
</div>
<div class="section"><h2>Configuring Stylesheets File</h2>
-<p>If a custom <stylesheetfile/> parameter is specified, you will be able to use it:</p>
-<ul><li>if <stylesheetfile/> is a given file, you could use an absolute or a relative path, for instance:<div class="source"><pre><project>
+<p>If a custom <a href="../javadoc-mojo.html#stylesheetfile"><stylesheetfile/></a> parameter is specified, you will be able to use it:</p>
+<ul><li>if <a href="../javadoc-mojo.html#stylesheetfile"><stylesheetfile/></a> is a given file, you could use an absolute or a relative path, for instance:<div class="source"><pre><project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
<configuration>
<stylesheetfile>${basedir}/path/to/your/stylesheetfile.css</stylesheetfile>
...
@@ -342,34 +343,20 @@ Vincent Siveton" />
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
</pre>
</div>
</li>
-<li>since 2.6, <stylesheetfile/> could be a resource in your project directory, i.e. <tt>src/main/java</tt>, <tt>src/main/resources</tt> or <tt>src/main/javadoc</tt>, for instance:<div class="source"><pre><project>
+<li>since 2.6, <a href="../javadoc-mojo.html#stylesheetfile"><stylesheetfile/></a> could be a resource in your project directory, i.e. <tt>src/main/java</tt>, <tt>src/main/resources</tt> or <tt>src/main/javadoc</tt>, for instance:<div class="source"><pre><project>
...
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <stylesheetfile>path/to/your/stylesheet.css</stylesheetfile>
- ...
- </configuration>
- </plugin>
- </plugins>
- ...
- </build>
- ...
- <!-- Or the following
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
<configuration>
<stylesheetfile>path/to/your/stylesheet.css</stylesheetfile>
...
@@ -377,20 +364,20 @@ Vincent Siveton" />
</plugin>
</plugins>
...
- </reporting>
- -->
+ </reporting> (or </build>)
...
</project>
</pre>
</div>
</li>
-<li>since 2.6, <stylesheetfile/> could be a resource in the Javadoc plugin dependencies, for instance:<div class="source"><pre><project>
+<li>since 2.6, <a href="../javadoc-mojo.html#stylesheetfile"><stylesheetfile/></a> could be a resource in the Javadoc plugin dependencies, for instance:<div class="source"><pre><project>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.6.1</version>
<configuration>
<stylesheetfile>path/to/your/stylesheet.css</stylesheetfile>
</configuration>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/tag-configuration.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/tag-configuration.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/tag-configuration.html Sun Aug 19 17:31:42 2012
@@ -75,8 +75,8 @@ Maria Odea Ching" />
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -304,21 +304,31 @@ Maria Odea Ching" />
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Configuring Custom Javadoc Tags</h2>
-<p>You can configure any custom tags used in your javadoc via the <tags/> element:</p>
+<p>To configure any custom tags, use <a href="../javadoc-mojo.html#tags"><tags/></a> parameter as shown below. Each tag will be consist of a <name/>, a <placement/> and a <head/>. The <placement/> should be a combination of the letters Xaoptcmf:</p>
+<ul><li>X (disable tag)</li>
+<li>a (all)</li>
+<li>o (overview)</li>
+<li>p (packages)</li>
+<li>t (types, that is classes and interfaces)</li>
+<li>c (constructors)</li>
+<li>m (methods)</li>
+<li>f (fields)</li>
+</ul>
+<p>For instance, with the following configuration:</p>
<div class="source"><pre><project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
...
<tags>
<tag>
<name>todo</name>
- <!-- Should be a combination of the letters Xaoptcmf -->
+ <!-- todo tag for all places -->
<placement>a</placement>
<head>To do something:</head>
</tag>
@@ -328,11 +338,30 @@ Maria Odea Ching" />
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
</pre>
</div>
+<p>and with the following todo tag in a class:</p>
+<div class="source"><pre>/**
+ * Hello world!
+ *
+ * @todo complete me!
+ */
+public class App {}
+</pre>
+</div>
+<p>the Javadoc tool will generate the following Javadoc:</p>
+<div class="source"><pre>public class App
+extends Object
+
+Hello world!
+
+To do something:
+ complete me!
+</pre>
+</div>
</div>
</div>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/taglet-configuration.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/taglet-configuration.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/taglet-configuration.html Sun Aug 19 17:31:42 2012
@@ -74,8 +74,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,18 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Configuring Custom Taglets</h2>
-<p>You could configure any custom taglets in your Javadoc Plugin configuration via the <taglet/>, <taglets/> or <tagletArtifacts/> elements, depending the number of taglets used.</p>
+<p>You could configure any custom taglets in your Javadoc Plugin configuration via the <a href="../javadoc-mojo.html#taglet"><taglet/></a>, <a href="../javadoc-mojo.html#taglets"><taglets/></a>, or <a href="../javadoc-mojo.html#tagletArtifacts"><tagletArtifacts/></a> parameters, depending the number of taglets used.</p>
<p>For more information about the taglet technology, please refer to <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/taglet/overview.html" class="externalLink">http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/taglet/overview.html</a>.</p>
<div class="section"><h3>One Taglet</h3>
-<p>For one known Taglet, just use the <taglet/> element:</p>
+<p>For one known Taglet, just use the <a href="../javadoc-mojo.html#taglet"><taglet/></a> parameter:</p>
<div class="source"><pre><project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
...
<taglet>package.to.YourTagletClass</taglet>
@@ -329,22 +329,22 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
</pre>
</div>
</div>
<div class="section"><h3>Several Taglets</h3>
-<p>For several known Taglets, just use the <taglets/> element:</p>
+<p>For several known Taglets, just use the <a href="../javadoc-mojo.html#taglets"><taglets/></a> parameter:</p>
<div class="source"><pre><project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
...
<taglets>
@@ -374,20 +374,20 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
</pre>
</div>
-<p>If it is several Taglets in the same Taglet artifact, you could use the <taglets/> and the <tagletArtifact/> elements:</p>
+<p>If it is several Taglets in the same Taglet artifact, you could use the <a href="../javadoc-mojo.html#taglets"><taglets/></a> and the <a href="../javadoc-mojo.html#tagletArtifact"><tagletArtifact/></a> parameters:</p>
<div class="source"><pre><project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
...
<taglets>
@@ -411,20 +411,20 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
</pre>
</div>
-<p>If you don't know the Taglets or if you want to auto-detect Taglet class names, you could use the <tagletArtifacts/> element:</p>
+<p>If you don't know the Taglets or if you want to auto-detect Taglet class names, you could use the <a href="../javadoc-mojo.html#tagletArtifacts"><tagletArtifacts/></a> parameter:</p>
<div class="source"><pre><project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
...
<tagletArtifacts>
@@ -446,7 +446,7 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
</pre>
Modified: websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/test-javadocs.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/test-javadocs.html (original)
+++ websites/production/maventest/content/plugins/maven-javadoc-plugin-latest/examples/test-javadocs.html Sun Aug 19 17:31:42 2012
@@ -74,8 +74,8 @@
- | Last Published: 2009-07-26
- | Version: 2.6
+ | Last Published: 2009-10-23
+ | Version: 2.6.1
</div>
<div class="clear">
<hr/>
@@ -303,10 +303,6 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Generating Test Javadocs</h2>
-<p>There are two ways to generate the test javadocs in the Maven Javadoc plugin:</p>
-<ul><li>using the javadoc:test-javadoc goal</li>
-<li>using the <reportSets/> configuration parameter</li>
-</ul>
<p>Here is a typical project used by the Maven Javadoc plugin:</p>
<div class="source"><pre>
yourproject
@@ -346,12 +342,12 @@ yourproject
<div class="source"><pre>
<project>
...
- <reporting>
+ <build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<configuration>
<doctitle>My API for ${project.name} ${project.version}</doctitle> <!-- Used by javadoc:javadoc goal -->
<windowtitle>My API for ${project.name} ${project.version}</windowtitle> <!-- Used by javadoc:javadoc goal -->
@@ -362,14 +358,17 @@ yourproject
</configuration>
</plugin>
</plugins>
- </reporting>
+ </build>
...
</project>
</pre>
</div>
<p>You could call <i>mvn javadoc:test-javadoc</i> or <i>mvn site</i>. See <a href="../test-javadoc-mojo.html">javadoc:test-javadoc parameters</a> for more informations.</p>
-<p><b>Note</b>: If you don't set <testDoctitle/> or <testWindowtitle/> parameters, the Test Javadoc report use the same configuration (i.e. <doctitle/> or <windowtitle/> parameters) that Javadoc report (backward compatible reasons).</p>
-<p><b>Note</b>: To run the reports selectively, you need to include only the reports that you prefer. Read the <a href="selective-javadocs-report.html">Selective Javadocs Reports</a> part for more information.</p>
+<p><b>Notes</b>:</p>
+<ol type="1"><li>If you don't set <testDoctitle/> or <testWindowtitle/> parameters, the Test Javadoc report use the same configuration (i.e. <doctitle/> or <windowtitle/> parameters) that Javadoc report (backward compatible reasons).</li>
+<li>To run the reports selectively, you need to include only the reports that you prefer. Read the <a href="./selective-javadocs-report.html">Selective Javadocs Reports</a> part for more information.</li>
+<li>To allow the copy of resources, you need to add the <docfilessubdirs/> parameter. Read the <a href="./javadoc-resources.html">Using Javadoc Resources</a> page for more information.</li>
+</ol>
</div>
<div class="section"><h3>Using the <reportSets/> configuration parameter</h3>
<p>You could also want a different kind of configuration for the Javadoc report and the test Javadoc report. For this, you need to configure the Maven Javadoc plugin in your pom.xml to handle the <reportSets/> configuration parameter, for instance:</p>
@@ -381,7 +380,7 @@ yourproject
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.5</version>
+ <version>2.6.1</version>
<reportSets>
<reportSet>
<id>html</id>