Modified: websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/javadoc-resources.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/javadoc-resources.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/javadoc-resources.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 Javadoc Resources</title> + <title>Apache Maven Javadoc Plugin – Using Javadoc Resources</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="20090910" /> - <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>Using Javadoc Resources<a name="Using_Javadoc_Resources"></a></h2> +<h2><a name="Using_Javadoc_Resources"></a>Using Javadoc Resources</h2> <p>The <a href="../javadoc-mojo.html#javadocDirectory"><javadocDirectory/></a> parameter can be used to include additional resources, like HTML or images, in the generated javadoc. You can then link to these resources in your javadoc comments. By default, all javadoc resources are in <i>${basedir}/src/main/javadoc</i> directory. Note that you need to set the docfilessubdirs parameter to copy these.</p> <p>Here is a typical set of resources files used by the Maven Javadoc plugin:</p> <div class="source"> @@ -240,10 +243,9 @@ yourproject |-- myapp `-- package.html |-- doc-files - `-- app.png -</pre></div> + `-- app.png</pre></div> <div class="section"> -<h3>Overview Comment File: <i>overview.html</i><a name="Overview_Comment_File:_overview.html"></a></h3> +<h3><a name="Overview_Comment_File:_overview.html"></a>Overview Comment File: <i>overview.html</i></h3> <p>These contain comments about the set of packages. The <i>overview.html</i> is a general documentation that applies to the entire application or set of packages.</p> <p>For more information, see <a class="externalLink" href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#overviewcomment";> javadoc - The Java API Documentation Generator, Overview Comment File</a>.</p> <p>Here is an example of an <i>overview.html</i> file, located in <i>${basedir}/src/main/javadoc/overview.html</i>:</p> @@ -256,8 +258,7 @@ yourproject <BODY> Short overview of the API. </BODY> -</HTML> -</pre></div> +</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 <a href="../javadoc-mojo.html#overview"><overview/></a> parameter, for instance:</p> <div class="source"> <pre><project> @@ -267,7 +268,7 @@ yourproject <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> ... <overview>${basedir}/overview.html</overview> @@ -278,10 +279,9 @@ yourproject ... </reporting> ... -</project> -</pre></div></div> +</project></pre></div></div> <div class="section"> -<h3>Package Comment File: <i>package.html</i><a name="Package_Comment_File:_package.html"></a></h3> +<h3><a name="Package_Comment_File:_package.html"></a>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 class="externalLink" href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#packagecomment";> javadoc - The Java API Documentation Generator, Package Comment Files</a> and <a class="externalLink" href="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#packagecomments";> 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/myapp/package.html</i>:</p> @@ -295,8 +295,7 @@ yourproject This is the core package of the application @since 1.0 </BODY> -</HTML> -</pre></div> +</HTML></pre></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 class="externalLink" href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#packagecomment";> 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/myapp/package-info.java</i>:</p> @@ -305,10 +304,9 @@ yourproject * This is the core package for the application * @since 1.0 */ -package org.apache.myapp; -</pre></div></div> +package org.apache.myapp;</pre></div></div> <div class="section"> -<h3>Miscellaneous Unprocessed Files: <i>doc-files</i><a name="Miscellaneous_Unprocessed_Files:_doc-files"></a></h3> +<h3><a name="Miscellaneous_Unprocessed_Files:_doc-files"></a>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 class="externalLink" href="http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/javadoc.html#unprocessed";> javadoc - The Java API Documentation Generator, Miscellaneous Unprocessed Files</a> and <a class="externalLink" href="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#images";>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> @@ -322,8 +320,7 @@ package org.apache.myapp; */ public class App { -} -</pre></div> +}</pre></div> <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> </div> </div> @@ -332,7 +329,7 @@ public class App </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/links-configuration.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/links-configuration.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/links-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 links and offlineLinks Parameters</title> + <title>Apache Maven Javadoc Plugin – Configuring links and offlineLinks Parameters</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 <tt>links</tt> Parameter<a name="Configuring_links_Parameter"></a></h2><!-- Using anchor links produces a Velocity error. --> +<h2><a name="Configuring_links_Parameter"></a>Configuring <tt>links</tt> Parameter</h2><!-- Using anchor links produces a Velocity error. --> <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> @@ -228,7 +231,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <links> <link>http://commons.apache.org/dbcp/apidocs/</link> @@ -240,8 +243,7 @@ </plugins> </reporting> (or </build>) ... -</project> -</pre></div> +</project></pre></div> <p><b>Important Note</b>: according the <a class="externalLink" href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#package-list";>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 class="externalLink" href="http://commons.apache.org/lang/";>Apache Commons Lang</a> i.e.:</p> <div class="source"> @@ -255,8 +257,7 @@ </dependency> </dependencies> ... -</project> -</pre></div> +</project></pre></div> <p>The added Javadoc link will be <a class="externalLink" href="http://commons.apache.org/lang/apidocs";>http://commons.apache.org/lang/apidocs</a>.</p> <p>Since 2.6, a <a class="externalLink" href="http://java.sun.com/reference/api/index.html";>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 class="externalLink" href="http://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#source";><source/></a> parameter in the <tt><a class="externalLink" href="http://maven.apache.org/plugins/maven-compiler-plugin";>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> @@ -269,11 +270,10 @@ </property> </javaApiLinks> ... -</configuration> -</pre></div><!-- Using anchor links produces a Velocity error. --> +</configuration></pre></div><!-- Using anchor links produces a Velocity error. --> <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<a name="Configuring_offlineLinks_Parameter"></a></h2> +<h2><a name="Configuring_offlineLinks_Parameter"></a>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> <div class="source"> <pre><project> @@ -283,8 +283,7 @@ <module>module2</module> </modules> ... -</project> -</pre></div> +</project></pre></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> @@ -296,7 +295,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/output-configuration.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/output-configuration.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/output-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 - Using Alternative Output Directory</title> + <title>Apache Maven Javadoc Plugin – Using Alternative Output Directory</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>Using Alternative Output Directory<a name="Using_Alternative_Output_Directory"></a></h2> +<h2><a name="Using_Alternative_Output_Directory"></a>Using Alternative Output Directory</h2> <p>To run the Javadocs reports in an other output directory, you need to configure Javadoc Plugin as follow:</p> <div class="source"> <pre><project> @@ -228,7 +231,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <reportOutputDirectory>${project.reporting.outputDirectory}/myoutput</reportOutputDirectory> <destDir>myapidocs</destDir> @@ -239,8 +242,7 @@ </plugins> </reporting> ... -</project> -</pre></div> +</project></pre></div> <p>Running <tt>mvn javadoc:javadoc</tt> will output the Javadoc in the <i>${project.reporting.outputDirectory}/myoutput/myapidocs</i> instead of the default directory, i.e. <i>${project.reporting.outputDirectory}/apidocs</i>.</p> <p><b>Note</b>: Running <i>mvn site</i> will automatically use the <i>${project.reporting.outputDirectory}</i> directory and in this case, <i>reportOutputDirectory</i> has no effect. Only, <i>testDestDir</i> and <i>destDir</i> could be used.</p></div> </div> @@ -250,7 +252,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/selective-javadocs-report.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/selective-javadocs-report.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/selective-javadocs-report.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 - Selective Javadocs Reports</title> + <title>Apache Maven Javadoc Plugin – Selective Javadocs Reports</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="20090913" /> - <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,10 +221,10 @@ <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>Selective Javadocs Reports<a name="Selective_Javadocs_Reports"></a></h2> +<h2><a name="Selective_Javadocs_Reports"></a>Selective Javadocs Reports</h2> <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<a name="Using_build_Tag"></a></h3> +<h3><a name="Using_build_Tag"></a>Using <build/> Tag</h3> <div class="source"> <pre><project> ... @@ -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> <!-- Default configuration for all reports --> ... @@ -252,11 +255,10 @@ </plugins> </build> ... -</project> -</pre></div> +</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<a name="Using_reporting_Tag"></a></h3> +<h3><a name="Using_reporting_Tag"></a>Using <reporting/> Tag</h3> <div class="source"> <pre> <project> @@ -266,7 +268,7 @@ <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 --> ... @@ -298,8 +300,7 @@ </plugins> </reporting> ... -</project> -</pre></div> +</project></pre></div> <p>Just call <tt>mvn site</tt> to generate the selected reports (main, test and aggregate javadocs).</p></div></div> </div> </div> @@ -308,7 +309,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/stylesheet-configuration.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/stylesheet-configuration.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/stylesheet-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 Stylesheets</title> + <title>Apache Maven Javadoc Plugin – Configuring Stylesheets</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>Configuring Stylesheets<a name="Configuring_Stylesheets"></a></h2> +<h2><a name="Configuring_Stylesheets"></a>Configuring Stylesheets</h2> <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> @@ -229,7 +232,7 @@ Vincent Siveton" /> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <stylesheet>maven</stylesheet> ... @@ -239,10 +242,9 @@ Vincent Siveton" /> ... </reporting> (or </build>) ... -</project> -</pre></div></div> +</project></pre></div></div> <div class="section"> -<h2>Configuring Stylesheets File<a name="Configuring_Stylesheets_File"></a></h2> +<h2><a name="Configuring_Stylesheets_File"></a>Configuring Stylesheets File</h2> <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: @@ -254,7 +256,7 @@ Vincent Siveton" /> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <stylesheetfile>${basedir}/path/to/your/stylesheetfile.css</stylesheetfile> ... @@ -264,8 +266,7 @@ Vincent Siveton" /> ... </reporting> (or </build>) ... -</project> -</pre></div></li> +</project></pre></div></li> <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> @@ -275,7 +276,7 @@ Vincent Siveton" /> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <stylesheetfile>path/to/your/stylesheet.css</stylesheetfile> ... @@ -285,8 +286,7 @@ Vincent Siveton" /> ... </reporting> (or </build>) ... -</project> -</pre></div></li> +</project></pre></div></li> <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> @@ -296,7 +296,7 @@ Vincent Siveton" /> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> <stylesheetfile>path/to/your/stylesheet.css</stylesheetfile> </configuration> @@ -312,8 +312,7 @@ Vincent Siveton" /> ... </build> ... -</project> -</pre></div></li></ul></div> +</project></pre></div></li></ul></div> </div> </div> <div class="clear"> @@ -321,7 +320,7 @@ Vincent Siveton" /> </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/tag-configuration.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/tag-configuration.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/tag-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 Custom Javadoc Tags</title> + <title>Apache Maven Javadoc Plugin – Configuring Custom Javadoc Tags</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>Configuring Custom Javadoc Tags<a name="Configuring_Custom_Javadoc_Tags"></a></h2> +<h2><a name="Configuring_Custom_Javadoc_Tags"></a>Configuring Custom Javadoc Tags</h2> <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> @@ -239,7 +242,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> ... <tags> @@ -257,8 +260,7 @@ Maria Odea Ching" /> ... </reporting> (or </build>) ... -</project> -</pre></div> +</project></pre></div> <p>and with the following todo tag in a class:</p> <div class="source"> <pre>/** @@ -266,8 +268,7 @@ Maria Odea Ching" /> * * @todo complete me! */ -public class App {} -</pre></div> +public class App {}</pre></div> <p>the Javadoc tool will generate the following Javadoc:</p> <div class="source"> <pre>public class App @@ -276,8 +277,7 @@ extends Object Hello world! To do something: - complete me! -</pre></div></div> + complete me!</pre></div></div> </div> </div> <div class="clear"> @@ -285,7 +285,7 @@ To do something: </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/taglet-configuration.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/taglet-configuration.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/taglet-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 Custom Taglets</title> + <title>Apache Maven Javadoc Plugin – Configuring Custom Taglets</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,11 +221,11 @@ <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 Custom Taglets<a name="Configuring_Custom_Taglets"></a></h2> +<h2><a name="Configuring_Custom_Taglets"></a>Configuring Custom Taglets</h2> <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 class="externalLink" href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html";>http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html</a>.</p> <div class="section"> -<h3>One Taglet<a name="One_Taglet"></a></h3> +<h3><a name="One_Taglet"></a>One Taglet</h3> <p>For one known Taglet, just use the <a href="../javadoc-mojo.html#taglet"><taglet/></a> parameter:</p> <div class="source"> <pre><project> @@ -232,7 +235,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> ... <taglet>package.to.YourTagletClass</taglet> @@ -249,10 +252,9 @@ ... </reporting> (or </build>) ... -</project> -</pre></div></div> +</project></pre></div></div> <div class="section"> -<h3>Several Taglets<a name="Several_Taglets"></a></h3> +<h3><a name="Several_Taglets"></a>Several Taglets</h3> <p>For several known Taglets, just use the <a href="../javadoc-mojo.html#taglets"><taglets/></a> parameter:</p> <div class="source"> <pre><project> @@ -262,7 +264,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> ... <taglets> @@ -294,8 +296,7 @@ ... </reporting> (or </build>) ... -</project> -</pre></div> +</project></pre></div> <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> @@ -305,7 +306,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> ... <taglets> @@ -331,8 +332,7 @@ ... </reporting> (or </build>) ... -</project> -</pre></div> +</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 <a href="../javadoc-mojo.html#tagletArtifacts"><tagletArtifacts/></a> parameter:</p> <div class="source"> <pre><project> @@ -342,7 +342,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</version> <configuration> ... <tagletArtifacts> @@ -366,8 +366,7 @@ ... </reporting> (or </build>) ... -</project> -</pre></div></div></div> +</project></pre></div></div></div> </div> </div> <div class="clear"> @@ -375,7 +374,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/test-javadocs.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/test-javadocs.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/examples/test-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 - Generating Test Javadocs</title> + <title>Apache Maven Javadoc Plugin – Generating Test Javadocs</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="20090819" /> - <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>Generating Test Javadocs<a name="Generating_Test_Javadocs"></a></h2> +<h2><a name="Generating_Test_Javadocs"></a>Generating Test Javadocs</h2> <p>Here is a typical project used by the Maven Javadoc plugin:</p> <div class="source"> <pre> @@ -251,10 +254,9 @@ yourproject |-- myapp `-- package.html |-- doc-files - `-- app.png -</pre></div> + `-- app.png</pre></div> <div class="section"> -<h3>Using the <i>javadoc:test-javadoc</i> goal<a name="Using_the_javadoc:test-javadoc_goal"></a></h3> +<h3><a name="Using_the_javadoc:test-javadoc_goal"></a>Using the <i>javadoc:test-javadoc</i> goal</h3> <p>You need to configure the Maven Javadoc plugin in your pom.xml, for instance:</p> <div class="source"> <pre> @@ -265,7 +267,7 @@ yourproject <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> - <version>2.10.1</version> + <version>2.10.2</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 --> @@ -278,8 +280,7 @@ yourproject </plugins> </build> ... -</project> -</pre></div> +</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>Notes</b>:</p> <ol style="list-style-type: decimal"> @@ -287,7 +288,7 @@ yourproject <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<a name="Using_the_reportSets_configuration_parameter"></a></h3> +<h3><a name="Using_the_reportSets_configuration_parameter"></a>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> <div class="source"> <pre> @@ -298,7 +299,7 @@ yourproject <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> @@ -327,8 +328,7 @@ yourproject </plugins> </reporting> ... -</project> -</pre></div> +</project></pre></div> <p>You need to call <i>mvn site</i>.</p></div></div> </div> </div> @@ -337,7 +337,7 @@ yourproject </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/faq.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/faq.html (original) +++ websites/production/maven/content/plugins-archives/maven-javadoc-plugin-LATEST/faq.html Sat Mar 14 00:06:30 2015 @@ -1,18 +1,18 @@ <!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 - Frequently Asked Questions</title> + <title>Apache Maven Javadoc Plugin – Frequently Asked Questions</title> <style type="text/css" media="all"> @import url("./css/maven-base.css"); @import url("./css/maven-theme.css"); @import url("./css/site.css"); </style> <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> - <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> @@ -47,8 +47,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/> @@ -140,7 +140,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"> @@ -162,10 +162,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> @@ -174,9 +171,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"> @@ -231,7 +234,7 @@ software distributed under the License i KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --><div class="section"> -<h2><a name="top">Frequently Asked Questions</a><a name="Frequently_Asked_Questions"></a></h2> +<h2><a name="Frequently_Asked_Questions"></a><a name="top">Frequently Asked Questions</a></h2> <ol style="list-style-type: decimal"> <li><a href="#What_are_the_Javadoc_options_supported_by_the_Maven_Javadoc_Plugin">What are the Javadoc options supported by the Maven Javadoc Plugin?</a></li> <li><a href="#Where_in_the_pom.xml_do_I_configure_the_Javadoc_Plugin">Where in the pom.xml do I configure the Javadoc Plugin?</a></li> @@ -721,7 +724,7 @@ mvn deploy:deploy-file \ </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>.
