Modified: websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/aggregate-dependency-sources.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/aggregate-dependency-sources.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/aggregate-dependency-sources.html Sat Mar 14 00:06:30 2015 @@ -1,11 +1,11 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> <!-- - | Generated by Apache Maven Doxia at 2014-09-27 + | Generated by Apache Maven Doxia at 2015-03-14 | Rendered using Apache Maven Stylus Skin 1.5 --> <html xmlns="http://www.w3.org/1999/xhtml";> <head> - <title>Apache Maven Javadoc Plugin - Aggregating Javadocs from Dependency Sources</title> + <title>Apache Maven Javadoc Plugin – Aggregating Javadocs from Dependency Sources</title> <style type="text/css" media="all"> @import url("../css/maven-base.css"); @import url("../css/maven-theme.css"); @@ -14,7 +14,7 @@ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> <meta name="author" content="John Casey" /> <meta name="Date-Creation-yyyymmdd" content="20100412" /> - <meta name="Date-Revision-yyyymmdd" content="20140927" /> + <meta name="Date-Revision-yyyymmdd" content="20150314" /> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> @@ -49,8 +49,8 @@ </div> <div class="xright"> <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/"; class="externalLink">Javadoc Tool</a> - | Last Published: 2014-09-27 - | Version: 2.10.1 + | Last Published: 2015-03-14 + | Version: 2.10.2 </div> <div class="clear"> <hr/> @@ -142,7 +142,7 @@ </ul> <h5>Project Documentation</h5> <ul> - <li class="collapsed"> + <li class="collapsed"> <a href="../project-info.html">Project Information</a> </li> <li class="collapsed"> @@ -164,10 +164,7 @@ <a href="../../../jxr/index.html">JXR</a> </li> <li class="none"> - <a href="../../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../../index.html">Maven 2 & 3</a> + <a href="../../../ref/current">Maven</a> </li> <li class="none"> <a href="../../../pom/index.html">Parent POMs</a> @@ -176,9 +173,15 @@ <a href="../../index.html">Plugins</a> </li> <li class="none"> + <a href="../../../plugin-testing/index.html">Plugin Testing</a> + </li> + <li class="none"> <a href="../../../plugin-tools/index.html">Plugin Tools</a> </li> <li class="none"> + <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a> + </li> + <li class="none"> <a href="../../../scm/index.html">SCM</a> </li> <li class="none"> @@ -218,7 +221,7 @@ <div id="bodyColumn"> <div id="contentBox"> <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt- format.html --><div class="section"> -<h2>Aggregating Javadocs from Dependency Sources<a name="Aggregating_Javadocs_from_Dependency_Sources"></a></h2> +<h2><a name="Aggregating_Javadocs_from_Dependency_Sources"></a>Aggregating Javadocs from Dependency Sources</h2> <p><b>Since: 2.7</b></p> <p>Consider the following project dependency graph:</p> <div class="source"> @@ -238,13 +241,12 @@ org.test:project-distro:0.1 |--> org.test.dep:project-C:1.0 | `--> commons-cli:commons-cli:1.0 - </pre></div> <p>Suppose you maintain a series of projects with separate release cycles, along with another project which serves to integrate everything together to provide a tested platform, with its dependencies coordinated for compatibility. In order to produce the <tt>project-distro</tt> distribution, you'll want to produce a comprehensive set of javadocs containing not only what little code is in the distro project itself - which isn't likely to be very enlightening - but also the javadocs for your other projects, which are dependencies of the distribution.</p> <p>Since version <i>2.7</i> of the maven-javadoc-plugin, you can do this using the <tt>includeDependencySources</tt> flag and its associated configuration options. Using this flag, it's possible to aggregate sources from other modules in a multi-module build <i>or</i> use the <tt>sources</tt> and <tt>test-sources</tt> jars published alongside the main artifacts for your projects. It's also possible to fine-tune which dependencies' sources should be aggregated, and which ignored. Last but not least, it's possible to include non-source javadoc configurations and resources from your dependencies by publishing <tt>javadoc-resources</tt> and <tt>test-javadoc-resources</tt> bundle artifacts alongside your dependencies' main artifacts.</p> <p>To get started, let's look at how to lay the ground work for dependency-driven javadoc aggregation.</p> <div class="section"> -<h3>Preparing Dependencies for Aggregation<a name="Preparing_Dependencies_for_Aggregation"></a></h3> +<h3><a name="Preparing_Dependencies_for_Aggregation"></a>Preparing Dependencies for Aggregation</h3> <p>Dependency-driven javadoc aggregation works by resolving the sources for included dependencies, then including these sources in the javadoc production process for your project. As is common practice with Maven, dependency sources will be resolved from other modules in the current reactor if they are available there. Otherwise, the plugin will attempt to resolve the appropriate sources artifact for the dependency: <tt>sources</tt> for main javadocs, <tt>test-sources</tt> for test javadocs. <b>NOTE: If your configuration includes a dependency but that dependency's source artifact is unavailable, the javadoc plugin will fail.</b></p> <p>The recommended method for producing these source artifacts is the <a class="externalLink" href="http://maven.apache.org/plugins/maven-source-plugin/";>maven-source-plugin</a>. The following simple example shows how to produce source artifacts:</p> <div class="source"> @@ -276,17 +278,15 @@ org.test:project-distro:0.1 </plugins> </build> [...] -</project> -</pre></div> +</project></pre></div> <p><b>NOTE:</b> If you don't intend to generate test javadocs that include dependency sources, you can omit the <tt>test-jar-no-fork</tt> goal above.</p> <p>At this point, your project is ready to produce the artifacts necessary to support dependency-driven javadoc aggregation. The next time you install or deploy the project, the appropriate artifacts will be available for your distribution project to consume.</p></div> <div class="section"> -<h3>Fine-Tuning Included Dependencies<a name="Fine-Tuning_Included_Dependencies"></a></h3> +<h3><a name="Fine-Tuning_Included_Dependencies"></a>Fine-Tuning Included Dependencies</h3> <p>Unifying the javadocs of your project and its dependencies is fine, but let's not go too far. Along with your own upstream projects, your distribution may include dependencies on external projects. It may not be appropriate to include javadocs for these projects in your distribution; linking to them is usually better. In any case, you may not have enough influence over these external projects to get them to produce source artifacts like the ones discussed above. In our original example, take a look at that last direct dependency:</p> <div class="source"> <pre> `--> commons-cli:commons-cli:1.0 - </pre></div> <p>This is a pretty common direct dependency for projects that provide command-line execution options. But consider what happens if commons-cli doesn't provide a <tt>sources</tt> jar: dependency-driven javadoc aggregation would fail for any project that contained commons-cli as a direct dependency. To avoid this case, you have the option to fine-tune which dependencies get included in the javadoc aggregation process. In your distribution project, add configuraiton for the <tt>maven-javadoc-plugin</tt> similar to the following:</p> <div class="source"> @@ -300,7 +300,7 @@ org.test:project-distro:0.1 [...] <plugin> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <executions> <execution> <id>javadoc-jar</id> @@ -322,8 +322,7 @@ org.test:project-distro:0.1 </plugin> </plugins> </build> -</project> -</pre></div> +</project></pre></div> <p><b>NOTE:</b> The above configuration excludes <b>only</b> commons-cli. If you have multiple external dependencies, it may be easier to configure which dependencies are <b>included</b>, as follows:</p> <div class="source"> <pre> [...] @@ -336,10 +335,9 @@ org.test:project-distro:0.1 <dependencySourceInclude>org.test.dep:*</dependencySourceInclude> </dependencySourceIncludes> </configuration> - [...] -</pre></div></div> + [...]</pre></div></div> <div class="section"> -<h3>Including Javadoc Resources from Dependencies<a name="Including_Javadoc_Resources_from_Dependencies"></a></h3> +<h3><a name="Including_Javadoc_Resources_from_Dependencies"></a>Including Javadoc Resources from Dependencies</h3> <p>Many projects choose customize their javadoc configuration beyond the defaults.</p> <p>If you have customized configuration for generating the javadocs in these dependency projects, you may wish to propagate these customizations to the distribution project itself. To do this, use the <tt>resource-bundle</tt> and <tt>test-resource-bundle</tt> goals, new in version <b>2.7</b> of the javadoc plugin. These will create new artifacts that contain the javadoc configuration options plus the contents of ${javadocDirectory} (which defaults to src/main/javadoc), or ${tetsJavadocDirectory} (which defaults to src/test/javadoc) depending on the bundle goal. If these artifacts are available, the dependency-driven aggregation process will include the content and configuration they contain when generating the javadocs for your distribution. The following example shows how to produce these artifacts:</p> <div class="source"> @@ -354,7 +352,7 @@ org.test:project-distro:0.1 [...] <plugin> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <executions> <execution> <id>resource-bundles</id> @@ -376,8 +374,7 @@ org.test:project-distro:0.1 </plugins> </build> [...] -</project> -</pre></div> +</project></pre></div> <p><b>NOTE:</b> Again, if you don't need to generate test javadocs, you can omit the <tt>test-resource-bundle</tt> goal above.</p> <p><b>NOTE 2:</b> The configuration option <tt>detectOfflineLinks</tt> is provided as an example only. It is not required.</p></div></div> </div> @@ -387,7 +384,7 @@ org.test:project-distro:0.1 </div> <div id="footer"> <div class="xright"> - © 2004-2014 + © 2004-2015 The Apache Software Foundation - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>.
Modified: websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/aggregate.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/aggregate.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/aggregate.html Sat Mar 14 00:06:30 2015 @@ -1,11 +1,11 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> <!-- - | Generated by Apache Maven Doxia at 2014-09-27 + | Generated by Apache Maven Doxia at 2015-03-14 | Rendered using Apache Maven Stylus Skin 1.5 --> <html xmlns="http://www.w3.org/1999/xhtml";> <head> - <title>Apache Maven Javadoc Plugin - Aggregating Javadocs for Multi-Projects</title> + <title>Apache Maven Javadoc Plugin – Aggregating Javadocs for Multi-Projects</title> <style type="text/css" media="all"> @import url("../css/maven-base.css"); @import url("../css/maven-theme.css"); @@ -15,7 +15,7 @@ <meta name="author" content="Maria Odea Ching Vincent Siveton" /> <meta name="Date-Creation-yyyymmdd" content="20090804" /> - <meta name="Date-Revision-yyyymmdd" content="20140927" /> + <meta name="Date-Revision-yyyymmdd" content="20150314" /> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> @@ -50,8 +50,8 @@ Vincent Siveton" /> </div> <div class="xright"> <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/"; class="externalLink">Javadoc Tool</a> - | Last Published: 2014-09-27 - | Version: 2.10.1 + | Last Published: 2015-03-14 + | Version: 2.10.2 </div> <div class="clear"> <hr/> @@ -143,7 +143,7 @@ Vincent Siveton" /> </ul> <h5>Project Documentation</h5> <ul> - <li class="collapsed"> + <li class="collapsed"> <a href="../project-info.html">Project Information</a> </li> <li class="collapsed"> @@ -165,10 +165,7 @@ Vincent Siveton" /> <a href="../../../jxr/index.html">JXR</a> </li> <li class="none"> - <a href="../../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../../index.html">Maven 2 & 3</a> + <a href="../../../ref/current">Maven</a> </li> <li class="none"> <a href="../../../pom/index.html">Parent POMs</a> @@ -177,9 +174,15 @@ Vincent Siveton" /> <a href="../../index.html">Plugins</a> </li> <li class="none"> + <a href="../../../plugin-testing/index.html">Plugin Testing</a> + </li> + <li class="none"> <a href="../../../plugin-tools/index.html">Plugin Tools</a> </li> <li class="none"> + <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a> + </li> + <li class="none"> <a href="../../../scm/index.html">SCM</a> </li> <li class="none"> @@ -219,7 +222,7 @@ Vincent Siveton" /> <div id="bodyColumn"> <div id="contentBox"> <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt- format.html --><div class="section"> -<h2>Aggregating Javadocs For Multi-Projects<a name="Aggregating_Javadocs_For_Multi-Projects"></a></h2> +<h2><a name="Aggregating_Javadocs_For_Multi-Projects"></a>Aggregating Javadocs For Multi-Projects</h2> <p>For example, consider the following directory structure:</p> <div class="source"> <pre> @@ -231,10 +234,9 @@ Project | `-- pom.xml `-- Module3 `-- pom.xml - </pre></div> <div class="section"> -<h3>Using The <aggregate/> Parameter (<b>deprecated</b>)<a name="Using_The_aggregate_Parameter_deprecated"></a></h3> +<h3><a name="Using_The_aggregate_Parameter_deprecated"></a>Using The <aggregate/> Parameter (<b>deprecated</b>)</h3> <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> @@ -246,7 +248,7 @@ Project <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> ... <aggregate>true</aggregate> @@ -257,10 +259,9 @@ Project ... </reporting> (or </build>) ... -</project> -</pre></div></div> +</project></pre></div></div> <div class="section"> -<h3>Using The <tt>aggregate</tt> Goals<a name="Using_The_aggregate_Goals"></a></h3> +<h3><a name="Using_The_aggregate_Goals"></a>Using The <tt>aggregate</tt> Goals</h3> <p>The <a href="../javadoc-mojo.html#aggregate"><aggregate/></a> parameter doesn't include generate source directories defined using the <a class="externalLink" href="http://mojo.codehaus.org/build-helper-maven-plugin/add-source-mojo.html";>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> @@ -270,7 +271,7 @@ Project <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <!-- Default configuration for all reports --> ... @@ -294,8 +295,7 @@ Project </plugins> </build> ... -</project> -</pre></div> +</project></pre></div> <div class="source"> <pre> <project> @@ -305,7 +305,7 @@ Project <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <!-- Default configuration for all reports --> ... @@ -338,8 +338,7 @@ Project </plugins> </reporting> ... -</project> -</pre></div> +</project></pre></div> <p>The Javadoc plugin contains several <tt>aggregate</tt> goals to be use with an aggregator project. Here is the full list of all <tt>aggregate</tt> goals:</p> <ul> <li><a href="../aggregate-mojo.html">javadoc:aggregate</a> to generate the Javadoc files.</li> @@ -353,7 +352,7 @@ Project </div> <div id="footer"> <div class="xright"> - © 2004-2014 + © 2004-2015 The Apache Software Foundation - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. Modified: websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/alternate-doclet.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/alternate-doclet.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/alternate-doclet.html Sat Mar 14 00:06:30 2015 @@ -1,11 +1,11 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> <!-- - | Generated by Apache Maven Doxia at 2014-09-27 + | Generated by Apache Maven Doxia at 2015-03-14 | Rendered using Apache Maven Stylus Skin 1.5 --> <html xmlns="http://www.w3.org/1999/xhtml";> <head> - <title>Apache Maven Javadoc Plugin - Using Alternate Doclet</title> + <title>Apache Maven Javadoc Plugin – Using Alternate Doclet</title> <style type="text/css" media="all"> @import url("../css/maven-base.css"); @import url("../css/maven-theme.css"); @@ -15,7 +15,7 @@ <meta name="author" content="Vincent Siveton Maria Odea Ching" /> <meta name="Date-Creation-yyyymmdd" content="20090804" /> - <meta name="Date-Revision-yyyymmdd" content="20140927" /> + <meta name="Date-Revision-yyyymmdd" content="20150314" /> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> @@ -50,8 +50,8 @@ Maria Odea Ching" /> </div> <div class="xright"> <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/"; class="externalLink">Javadoc Tool</a> - | Last Published: 2014-09-27 - | Version: 2.10.1 + | Last Published: 2015-03-14 + | Version: 2.10.2 </div> <div class="clear"> <hr/> @@ -143,7 +143,7 @@ Maria Odea Ching" /> </ul> <h5>Project Documentation</h5> <ul> - <li class="collapsed"> + <li class="collapsed"> <a href="../project-info.html">Project Information</a> </li> <li class="collapsed"> @@ -165,10 +165,7 @@ Maria Odea Ching" /> <a href="../../../jxr/index.html">JXR</a> </li> <li class="none"> - <a href="../../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../../index.html">Maven 2 & 3</a> + <a href="../../../ref/current">Maven</a> </li> <li class="none"> <a href="../../../pom/index.html">Parent POMs</a> @@ -177,9 +174,15 @@ Maria Odea Ching" /> <a href="../../index.html">Plugins</a> </li> <li class="none"> + <a href="../../../plugin-testing/index.html">Plugin Testing</a> + </li> + <li class="none"> <a href="../../../plugin-tools/index.html">Plugin Tools</a> </li> <li class="none"> + <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a> + </li> + <li class="none"> <a href="../../../scm/index.html">SCM</a> </li> <li class="none"> @@ -219,7 +222,7 @@ Maria Odea Ching" /> <div id="bodyColumn"> <div id="contentBox"> <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt- format.html --><div class="section"> -<h2>Using Alternate Doclet<a name="Using_Alternate_Doclet"></a></h2> +<h2><a name="Using_Alternate_Doclet"></a>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 (<a class="externalLink" href="http://www.umlgraph.org/";>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 class="externalLink" href="http://www.graphviz.org/";>http://www.graphviz.org/</a>.</p> @@ -231,7 +234,7 @@ Maria Odea Ching" /> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet> @@ -249,8 +252,7 @@ Maria Odea Ching" /> </plugins> </reporting> (or </build>) ... -</project> -</pre></div> +</project></pre></div> <p><b>Note</b>:</p> <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> @@ -258,7 +260,7 @@ Maria Odea Ching" /> <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></div> <div class="section"> -<h2>Using Alternate Doclet In Addition To The Javadoc Doclet<a name="Using_Alternate_Doclet_In_Addition_To_The_Javadoc_Doclet"></a></h2> +<h2><a name="Using_Alternate_Doclet_In_Addition_To_The_Javadoc_Doclet"></a>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 (<a class="externalLink" href="http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html/";>http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html/</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"> @@ -269,7 +271,7 @@ Maria Odea Ching" /> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <reportSets> <reportSet> <id>html</id> @@ -309,8 +311,7 @@ Maria Odea Ching" /> </plugins> </reporting> ... -</project> -</pre></div></div> +</project></pre></div></div> </div> </div> <div class="clear"> @@ -318,7 +319,7 @@ Maria Odea Ching" /> </div> <div id="footer"> <div class="xright"> - © 2004-2014 + © 2004-2015 The Apache Software Foundation - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. Modified: websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/alternate-javadoc-tool.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/alternate-javadoc-tool.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/alternate-javadoc-tool.html Sat Mar 14 00:06:30 2015 @@ -1,11 +1,11 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> <!-- - | Generated by Apache Maven Doxia at 2014-09-27 + | Generated by Apache Maven Doxia at 2015-03-14 | Rendered using Apache Maven Stylus Skin 1.5 --> <html xmlns="http://www.w3.org/1999/xhtml";> <head> - <title>Apache Maven Javadoc Plugin - Using Alternate Javadoc Tool</title> + <title>Apache Maven Javadoc Plugin – Using Alternate Javadoc Tool</title> <style type="text/css" media="all"> @import url("../css/maven-base.css"); @import url("../css/maven-theme.css"); @@ -14,7 +14,7 @@ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> <meta name="author" content="Vincent Siveton" /> <meta name="Date-Creation-yyyymmdd" content="20090804" /> - <meta name="Date-Revision-yyyymmdd" content="20140927" /> + <meta name="Date-Revision-yyyymmdd" content="20150314" /> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> @@ -49,8 +49,8 @@ </div> <div class="xright"> <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/"; class="externalLink">Javadoc Tool</a> - | Last Published: 2014-09-27 - | Version: 2.10.1 + | Last Published: 2015-03-14 + | Version: 2.10.2 </div> <div class="clear"> <hr/> @@ -142,7 +142,7 @@ </ul> <h5>Project Documentation</h5> <ul> - <li class="collapsed"> + <li class="collapsed"> <a href="../project-info.html">Project Information</a> </li> <li class="collapsed"> @@ -164,10 +164,7 @@ <a href="../../../jxr/index.html">JXR</a> </li> <li class="none"> - <a href="../../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../../index.html">Maven 2 & 3</a> + <a href="../../../ref/current">Maven</a> </li> <li class="none"> <a href="../../../pom/index.html">Parent POMs</a> @@ -176,9 +173,15 @@ <a href="../../index.html">Plugins</a> </li> <li class="none"> + <a href="../../../plugin-testing/index.html">Plugin Testing</a> + </li> + <li class="none"> <a href="../../../plugin-tools/index.html">Plugin Tools</a> </li> <li class="none"> + <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a> + </li> + <li class="none"> <a href="../../../scm/index.html">SCM</a> </li> <li class="none"> @@ -218,9 +221,9 @@ <div id="bodyColumn"> <div id="contentBox"> <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt- format.html --><div class="section"> -<h2>Using Alternate Javadoc Tool<a name="Using_Alternate_Javadoc_Tool"></a></h2> +<h2><a name="Using_Alternate_Javadoc_Tool"></a>Using Alternate Javadoc Tool</h2> <div class="section"> -<h3>Using Alternate Javadoc Executable<a name="Using_Alternate_Javadoc_Executable"></a></h3> +<h3><a name="Using_Alternate_Javadoc_Executable"></a>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 with the <a href="../javadoc-mojo.html#javadocExecutable"><javadocExecutable/></a> parameter. For example:</p> <div class="source"> @@ -231,7 +234,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <javadocExecutable>C:\jdk1.6.0\bin\javadoc.exe</javadocExecutable> ... @@ -241,11 +244,10 @@ </plugins> </reporting> (or </build>) ... -</project> -</pre></div> +</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<a name="Using_Alternate_Javadoc_Version"></a></h3> +<h3><a name="Using_Alternate_Javadoc_Version"></a>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"> @@ -256,7 +258,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <javadocVersion>1.5</javadocVersion> ... @@ -266,8 +268,7 @@ </plugins> </reporting> (or </build>) ... -</project> -</pre></div> +</project></pre></div> <p><b>Note</b>: You could have a warning if the <i>javadocVersion</i> specified is not the same that the Javadoc Tool executable.</p></div></div> </div> </div> @@ -276,7 +277,7 @@ </div> <div id="footer"> <div class="xright"> - © 2004-2014 + © 2004-2015 The Apache Software Foundation - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. Modified: websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/exclude-package-names.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/exclude-package-names.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/exclude-package-names.html Sat Mar 14 00:06:30 2015 @@ -1,11 +1,11 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> <!-- - | Generated by Apache Maven Doxia at 2014-09-27 + | Generated by Apache Maven Doxia at 2015-03-14 | Rendered using Apache Maven Stylus Skin 1.5 --> <html xmlns="http://www.w3.org/1999/xhtml";> <head> - <title>Apache Maven Javadoc Plugin - Excluding Packages</title> + <title>Apache Maven Javadoc Plugin – Excluding Packages</title> <style type="text/css" media="all"> @import url("../css/maven-base.css"); @import url("../css/maven-theme.css"); @@ -14,7 +14,7 @@ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> <meta name="author" content="Maria Odea Ching" /> <meta name="Date-Creation-yyyymmdd" content="20090912" /> - <meta name="Date-Revision-yyyymmdd" content="20140927" /> + <meta name="Date-Revision-yyyymmdd" content="20150314" /> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> @@ -49,8 +49,8 @@ </div> <div class="xright"> <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/"; class="externalLink">Javadoc Tool</a> - | Last Published: 2014-09-27 - | Version: 2.10.1 + | Last Published: 2015-03-14 + | Version: 2.10.2 </div> <div class="clear"> <hr/> @@ -142,7 +142,7 @@ </ul> <h5>Project Documentation</h5> <ul> - <li class="collapsed"> + <li class="collapsed"> <a href="../project-info.html">Project Information</a> </li> <li class="collapsed"> @@ -164,10 +164,7 @@ <a href="../../../jxr/index.html">JXR</a> </li> <li class="none"> - <a href="../../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../../index.html">Maven 2 & 3</a> + <a href="../../../ref/current">Maven</a> </li> <li class="none"> <a href="../../../pom/index.html">Parent POMs</a> @@ -176,9 +173,15 @@ <a href="../../index.html">Plugins</a> </li> <li class="none"> + <a href="../../../plugin-testing/index.html">Plugin Testing</a> + </li> + <li class="none"> <a href="../../../plugin-tools/index.html">Plugin Tools</a> </li> <li class="none"> + <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a> + </li> + <li class="none"> <a href="../../../scm/index.html">SCM</a> </li> <li class="none"> @@ -218,7 +221,7 @@ <div id="bodyColumn"> <div id="contentBox"> <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt- format.html --><div class="section"> -<h2>Excluding Packages<a name="Excluding_Packages"></a></h2> +<h2><a name="Excluding_Packages"></a>Excluding Packages</h2> <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 class="externalLink" href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#exclude";>Javadoc Tool</a>)</p> <p>For instance, with the following packages:</p> <div class="source"> @@ -237,8 +240,7 @@ 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> +com.mycompany.myapp.package3.util</pre></div> <p>You could have the following configuration:</p> <div class="source"> <pre><project> @@ -248,7 +250,7 @@ com.mycompany.myapp.package3.util <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <!-- Exclude packages: @@ -279,8 +281,7 @@ com.mycompany.myapp.package3.util ... </reporting> (or <build>) ... -</project> -</pre></div></div> +</project></pre></div></div> </div> </div> <div class="clear"> @@ -288,7 +289,7 @@ com.mycompany.myapp.package3.util </div> <div id="footer"> <div class="xright"> - © 2004-2014 + © 2004-2015 The Apache Software Foundation - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. Modified: websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/fix-javadocs.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/fix-javadocs.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/fix-javadocs.html Sat Mar 14 00:06:30 2015 @@ -1,11 +1,11 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> <!-- - | Generated by Apache Maven Doxia at 2014-09-27 + | Generated by Apache Maven Doxia at 2015-03-14 | Rendered using Apache Maven Stylus Skin 1.5 --> <html xmlns="http://www.w3.org/1999/xhtml";> <head> - <title>Apache Maven Javadoc Plugin - Fixing Javadoc Comments</title> + <title>Apache Maven Javadoc Plugin – Fixing Javadoc Comments</title> <style type="text/css" media="all"> @import url("../css/maven-base.css"); @import url("../css/maven-theme.css"); @@ -14,7 +14,7 @@ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> <meta name="author" content="Vincent Siveton" /> <meta name="Date-Creation-yyyymmdd" content="20090804" /> - <meta name="Date-Revision-yyyymmdd" content="20140927" /> + <meta name="Date-Revision-yyyymmdd" content="20150314" /> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> @@ -49,8 +49,8 @@ </div> <div class="xright"> <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/"; class="externalLink">Javadoc Tool</a> - | Last Published: 2014-09-27 - | Version: 2.10.1 + | Last Published: 2015-03-14 + | Version: 2.10.2 </div> <div class="clear"> <hr/> @@ -142,7 +142,7 @@ </ul> <h5>Project Documentation</h5> <ul> - <li class="collapsed"> + <li class="collapsed"> <a href="../project-info.html">Project Information</a> </li> <li class="collapsed"> @@ -164,10 +164,7 @@ <a href="../../../jxr/index.html">JXR</a> </li> <li class="none"> - <a href="../../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../../index.html">Maven 2 & 3</a> + <a href="../../../ref/current">Maven</a> </li> <li class="none"> <a href="../../../pom/index.html">Parent POMs</a> @@ -176,9 +173,15 @@ <a href="../../index.html">Plugins</a> </li> <li class="none"> + <a href="../../../plugin-testing/index.html">Plugin Testing</a> + </li> + <li class="none"> <a href="../../../plugin-tools/index.html">Plugin Tools</a> </li> <li class="none"> + <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a> + </li> + <li class="none"> <a href="../../../scm/index.html">SCM</a> </li> <li class="none"> @@ -218,21 +221,21 @@ <div id="bodyColumn"> <div id="contentBox"> <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt- format.html --><div class="section"> -<h2>Fixing Javadoc Comments<a name="Fixing_Javadoc_Comments"></a></h2> +<h2><a name="Fixing_Javadoc_Comments"></a>Fixing Javadoc Comments</h2> <p>When developers write code, they could forget to create (or update) the Javadoc comments. The <i>fix</i> and <i>test-fix</i> goals are interactive goals (i.e. used generally in command line) to fix the actual Javadoc comments in your classes.</p> <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<a name="Features_Summary"></a></h3> +<h3><a name="Features_Summary"></a>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 Clirr (<a class="externalLink" href="http://clirr.sourceforge.net";></a> via the <a class="externalLink" href="http://mojo.codehaus.org/clirr-maven-plugin/";>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<a name="Current_limitations"></a></h4> +<h4><a name="Current_limitations"></a>Current limitations</h4> <p>The <i>fix</i> and <i>test-fix</i> goals use intensively <a class="externalLink" href="http://qdox.codehaus.org/";>Qdox</a> to extract class/interface/method Javadoc from source files. Unfortunately, Qdox has <a class="externalLink" href="http://jira.codehaus.org/browse/QDOX";>some known issues</a>.</p></div></div> <div class="section"> -<h3>Example Call<a name="Example_Call"></a></h3> +<h3><a name="Example_Call"></a>Example Call</h3> <div class="source"> <pre>mvn javadoc:fix -DcomparisonVersion=1.0 ... @@ -252,24 +255,22 @@ y [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESSFUL [INFO] ------------------------------------------------------------------------ -... -</pre></div> +...</pre></div> <p>You could review the changes and commit.</p></div> <div class="section"> -<h3>Using Clirr Integration<a name="Using_Clirr_Integration"></a></h3> +<h3><a name="Using_Clirr_Integration"></a>Using Clirr Integration</h3> <p><b>Note</b>: a previous artifact should be deployed firstly.</p> <div class="section"> -<h4>Comparing against a specific version<a name="Comparing_against_a_specific_version"></a></h4> +<h4><a name="Comparing_against_a_specific_version"></a>Comparing against a specific version</h4> <p>By default, the goals compare the current code against the latest released version, which is lower than the current version. If you want to use another version, you need to specify it similar to the Maven Clirr Plugin:</p> <div class="source"> <pre>mvn javadoc:fix -DcomparisonVersion=1.0 ... [INFO] Clirr output file was created: target/clirr.txt [INFO] Clirr found API differences, i.e. new classes/interfaces or methods. -... -</pre></div></div> +...</pre></div></div> <div class="section"> -<h4>Using another Clirr version<a name="Using_another_Clirr_version"></a></h4> +<h4><a name="Using_another_Clirr_version"></a>Using another Clirr version</h4> <p>By default, the <i>fix</i> and <i>test-fix</i> goals use the <a class="externalLink" href="http://mojo.codehaus.org/clirr-maven-plugin/";>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> @@ -279,7 +280,7 @@ y <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> ... </configuration> @@ -296,8 +297,7 @@ y ... </build> ... -</project> -</pre></div></div></div></div> +</project></pre></div></div></div></div> </div> </div> <div class="clear"> @@ -305,7 +305,7 @@ y </div> <div id="footer"> <div class="xright"> - © 2004-2014 + © 2004-2015 The Apache Software Foundation - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. Modified: websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/group-configuration.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/group-configuration.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/group-configuration.html Sat Mar 14 00:06:30 2015 @@ -1,11 +1,11 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> <!-- - | Generated by Apache Maven Doxia at 2014-09-27 + | Generated by Apache Maven Doxia at 2015-03-14 | Rendered using Apache Maven Stylus Skin 1.5 --> <html xmlns="http://www.w3.org/1999/xhtml";> <head> - <title>Apache Maven Javadoc Plugin - Grouping Packages</title> + <title>Apache Maven Javadoc Plugin – Grouping Packages</title> <style type="text/css" media="all"> @import url("../css/maven-base.css"); @import url("../css/maven-theme.css"); @@ -15,7 +15,7 @@ <meta name="author" content="Vincent Siveton Maria Odea Ching" /> <meta name="Date-Creation-yyyymmdd" content="20090912" /> - <meta name="Date-Revision-yyyymmdd" content="20140927" /> + <meta name="Date-Revision-yyyymmdd" content="20150314" /> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> @@ -50,8 +50,8 @@ Maria Odea Ching" /> </div> <div class="xright"> <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/"; class="externalLink">Javadoc Tool</a> - | Last Published: 2014-09-27 - | Version: 2.10.1 + | Last Published: 2015-03-14 + | Version: 2.10.2 </div> <div class="clear"> <hr/> @@ -143,7 +143,7 @@ Maria Odea Ching" /> </ul> <h5>Project Documentation</h5> <ul> - <li class="collapsed"> + <li class="collapsed"> <a href="../project-info.html">Project Information</a> </li> <li class="collapsed"> @@ -165,10 +165,7 @@ Maria Odea Ching" /> <a href="../../../jxr/index.html">JXR</a> </li> <li class="none"> - <a href="../../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../../index.html">Maven 2 & 3</a> + <a href="../../../ref/current">Maven</a> </li> <li class="none"> <a href="../../../pom/index.html">Parent POMs</a> @@ -177,9 +174,15 @@ Maria Odea Ching" /> <a href="../../index.html">Plugins</a> </li> <li class="none"> + <a href="../../../plugin-testing/index.html">Plugin Testing</a> + </li> + <li class="none"> <a href="../../../plugin-tools/index.html">Plugin Tools</a> </li> <li class="none"> + <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a> + </li> + <li class="none"> <a href="../../../scm/index.html">SCM</a> </li> <li class="none"> @@ -219,7 +222,7 @@ Maria Odea Ching" /> <div id="bodyColumn"> <div id="contentBox"> <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt- format.html --><div class="section"> -<h2>Grouping Packages<a name="Grouping_Packages"></a></h2> +<h2><a name="Grouping_Packages"></a>Grouping Packages</h2> <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 class="externalLink" href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#group";>Javadoc Tool</a>).</p> <p>For instance, with the following packages:</p> <div class="source"> @@ -232,8 +235,7 @@ 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> +com.mycompany.myapp.package2.util</pre></div> <p>You could have the following configuration:</p> <div class="source"> <pre><project> @@ -243,7 +245,7 @@ com.mycompany.myapp.package2.util <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <groups> <group> @@ -332,8 +334,7 @@ com.mycompany.myapp.package2.util ... </reporting> (or </build>) ... -</project> -</pre></div></div> +</project></pre></div></div> </div> </div> <div class="clear"> @@ -341,7 +342,7 @@ com.mycompany.myapp.package2.util </div> <div id="footer"> <div class="xright"> - © 2004-2014 + © 2004-2015 The Apache Software Foundation - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. Modified: websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/help-configuration.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/help-configuration.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/help-configuration.html Sat Mar 14 00:06:30 2015 @@ -1,11 +1,11 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> <!-- - | Generated by Apache Maven Doxia at 2014-09-27 + | Generated by Apache Maven Doxia at 2015-03-14 | Rendered using Apache Maven Stylus Skin 1.5 --> <html xmlns="http://www.w3.org/1999/xhtml";> <head> - <title>Apache Maven Javadoc Plugin - Configuring Help</title> + <title>Apache Maven Javadoc Plugin – Configuring Help</title> <style type="text/css" media="all"> @import url("../css/maven-base.css"); @import url("../css/maven-theme.css"); @@ -14,7 +14,7 @@ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> <meta name="author" content="Vincent Siveton" /> <meta name="Date-Creation-yyyymmdd" content="20090804" /> - <meta name="Date-Revision-yyyymmdd" content="20140927" /> + <meta name="Date-Revision-yyyymmdd" content="20150314" /> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> @@ -49,8 +49,8 @@ </div> <div class="xright"> <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/"; class="externalLink">Javadoc Tool</a> - | Last Published: 2014-09-27 - | Version: 2.10.1 + | Last Published: 2015-03-14 + | Version: 2.10.2 </div> <div class="clear"> <hr/> @@ -142,7 +142,7 @@ </ul> <h5>Project Documentation</h5> <ul> - <li class="collapsed"> + <li class="collapsed"> <a href="../project-info.html">Project Information</a> </li> <li class="collapsed"> @@ -164,10 +164,7 @@ <a href="../../../jxr/index.html">JXR</a> </li> <li class="none"> - <a href="../../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../../index.html">Maven 2 & 3</a> + <a href="../../../ref/current">Maven</a> </li> <li class="none"> <a href="../../../pom/index.html">Parent POMs</a> @@ -176,9 +173,15 @@ <a href="../../index.html">Plugins</a> </li> <li class="none"> + <a href="../../../plugin-testing/index.html">Plugin Testing</a> + </li> + <li class="none"> <a href="../../../plugin-tools/index.html">Plugin Tools</a> </li> <li class="none"> + <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a> + </li> + <li class="none"> <a href="../../../scm/index.html">SCM</a> </li> <li class="none"> @@ -218,7 +221,7 @@ <div id="bodyColumn"> <div id="contentBox"> <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt- format.html --><div class="section"> -<h2>Configuring Help File<a name="Configuring_Help_File"></a></h2> +<h2><a name="Configuring_Help_File"></a>Configuring Help File</h2> <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: @@ -230,7 +233,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <helpfile>${basedir}/path/to/your/helpfile</helpfile> ... @@ -240,8 +243,7 @@ ... </reporting> (or </build>) ... -</project> -</pre></div></li> +</project></pre></div></li> <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> @@ -251,7 +253,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <helpfile>path/to/your/resource/help-doc.html</helpfile> ... @@ -261,8 +263,7 @@ ... </reporting> (or </build>) ... -</project> -</pre></div></li> +</project></pre></div></li> <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> @@ -272,7 +273,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <helpfile>path/to/your/resource/help-doc.html</helpfile> </configuration> @@ -288,8 +289,7 @@ ... </build> ... -</project> -</pre></div></li></ul></div> +</project></pre></div></li></ul></div> </div> </div> <div class="clear"> @@ -297,7 +297,7 @@ </div> <div id="footer"> <div class="xright"> - © 2004-2014 + © 2004-2015 The Apache Software Foundation - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. Modified: websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/javadoc-nofork.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/javadoc-nofork.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/javadoc-nofork.html Sat Mar 14 00:06:30 2015 @@ -1,11 +1,11 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> <!-- - | Generated by Apache Maven Doxia at 2014-09-27 + | Generated by Apache Maven Doxia at 2015-03-14 | Rendered using Apache Maven Stylus Skin 1.5 --> <html xmlns="http://www.w3.org/1999/xhtml";> <head> - <title>Apache Maven Javadoc Plugin - Generate Javadoc without duplicate execution of phase generate-sources.</title> + <title>Apache Maven Javadoc Plugin – Generate Javadoc without duplicate execution of phase generate-sources.</title> <style type="text/css" media="all"> @import url("../css/maven-base.css"); @import url("../css/maven-theme.css"); @@ -14,7 +14,7 @@ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> <meta name="author" content="Mirko Friedenhagen" /> <meta name="Date-Creation-yyyymmdd" content="20140319" /> - <meta name="Date-Revision-yyyymmdd" content="20140927" /> + <meta name="Date-Revision-yyyymmdd" content="20150314" /> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> @@ -49,8 +49,8 @@ </div> <div class="xright"> <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/"; class="externalLink">Javadoc Tool</a> - | Last Published: 2014-09-27 - | Version: 2.10.1 + | Last Published: 2015-03-14 + | Version: 2.10.2 </div> <div class="clear"> <hr/> @@ -142,7 +142,7 @@ </ul> <h5>Project Documentation</h5> <ul> - <li class="collapsed"> + <li class="collapsed"> <a href="../project-info.html">Project Information</a> </li> <li class="collapsed"> @@ -164,10 +164,7 @@ <a href="../../../jxr/index.html">JXR</a> </li> <li class="none"> - <a href="../../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../../index.html">Maven 2 & 3</a> + <a href="../../../ref/current">Maven</a> </li> <li class="none"> <a href="../../../pom/index.html">Parent POMs</a> @@ -176,9 +173,15 @@ <a href="../../index.html">Plugins</a> </li> <li class="none"> + <a href="../../../plugin-testing/index.html">Plugin Testing</a> + </li> + <li class="none"> <a href="../../../plugin-tools/index.html">Plugin Tools</a> </li> <li class="none"> + <a href="../../../apache-resource-bundles/index.html">Resource Bundles</a> + </li> + <li class="none"> <a href="../../../scm/index.html">SCM</a> </li> <li class="none"> @@ -218,7 +221,7 @@ <div id="bodyColumn"> <div id="contentBox"> <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt- format.html --><div class="section"> -<h2>Generate Javadoc without duplicate execution of phase generate-sources.<a name="Generate_Javadoc_without_duplicate_execution_of_phase_generate-sources."></a></h2> +<h2><a name="Generate_Javadoc_without_duplicate_execution_of_phase_generate-sources."></a>Generate Javadoc without duplicate execution of phase generate-sources.</h2> <ul> <li>The standard goals <tt>javadoc</tt> and <tt>test-javadoc</tt> invoke separate lifecyles <tt>generate-sources</tt> and <tt>generate-test-sources</tt>.</li> <li>In a CI environment you now might execute something like <tt>mvn clean deploy site site-deploy</tt>.</li> @@ -235,7 +238,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <reportSets> <reportSet> <reports> @@ -248,8 +251,7 @@ </plugins> </reporting> ... -</project> -</pre></div> +</project></pre></div> <p><b>Note</b>: These reports may not be used for aggregate reports.</p></li></ul></div> </div> </div> @@ -258,7 +260,7 @@ </div> <div id="footer"> <div class="xright"> - © 2004-2014 + © 2004-2015 The Apache Software Foundation - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>.
