Author: mfriedenhagen
Date: Wed Mar 19 21:22:30 2014
New Revision: 1579407
URL: http://svn.apache.org/r1579407
Log:
[MJAVADOC-369]: Update documentation and update @since to 2.9.2.
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-nofork.apt.vm
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocNoForkReport.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocNoForkReport.java
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocNoForkReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocNoForkReport.java?rev=1579407&r1=1579406&r2=1579407&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocNoForkReport.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocNoForkReport.java
Wed Mar 19 21:22:30 2014
@@ -29,10 +29,9 @@ import org.apache.maven.plugins.annotati
* <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/";>Javadoc
Tool</a>. Note that this
* goal does require generation of sources before site generation, e.g. by
invoking <tt>mvn clean deploy site</tt>.
*
- * @author <a href="mailto:eveni...@apache.org";>Emmanuel Venisse</a>
- * @author <a href="mailto:vincent.sive...@gmail.com";>Vincent Siveton</a>
+ * @author <a href="mailto:mfriedenha...@apache.org";>Mirko Friedenhagen</a>
* @version $Id$
- * @since 2.10
+ * @since 2.9.2
* @see <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/";>Javadoc
Tool</a>
* @see <a
href="http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#options";>Javadoc
Options</a>
*/
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocNoForkReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocNoForkReport.java?rev=1579407&r1=1579406&r2=1579407&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocNoForkReport.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestJavadocNoForkReport.java
Wed Mar 19 21:22:30 2014
@@ -30,9 +30,9 @@ import org.apache.maven.plugins.annotati
* goal does require generation of test sources before site generation, e.g.
by invoking
* <tt>mvn clean deploy site</tt>.
*
- * @author <a href="mailto:vincent.sive...@gmail.com";>Vincent Siveton</a>
+ * @author <a href="mailto:mfriedenha...@apache.org";>Mirko Friedenhagen</a>
* @version $Id$
- * @since 2.10
+ * @since 2.9.2
* @see <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/";>Javadoc
Tool</a>
* @see <a
href="http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#options";>Javadoc
Options </a>
*/
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-nofork.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-nofork.apt.vm?rev=1579407&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-nofork.apt.vm
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-nofork.apt.vm
Wed Mar 19 21:22:30 2014
@@ -0,0 +1,73 @@
+ ------
+ Generate Javadoc without duplicate execution of phase generate-sources.
+ ------
+ Mirko Friedenhagen
+ ------
+ 2014-03-19
+ ------
+
+~~ 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
+
+Generate Javadoc without duplicate execution of phase generate-sources.
+
+ * The standard goals <<<javadoc>>> and <<<test-javadoc>>> invoke separate
lifecyles
+ <<<generate-sources>>> and <<<generate-test-sources>>>.
+
+ * In a CI environment you now might execute something like <<<mvn clean
deploy site site-deploy>>>.
+
+ * During <<<site>>> build the standard reports will trigger
<<<generate-sources>>> or
+ <<<generate-test-sources>>> again, depending on your build this may take some
time, because
+ stuff like <<<enforcer>>> or generating stubs from a WDSL will be invoked
again, which may lead
+ to longer build times.
+
+ * See {{{https://jira.codehaus.org/browse/MJAVADOC-369}MJAVADOC-369}} as well.
+
+ * As of version 2.9.2 two new reports are defined, <<<javadoc-no-fork>>> and
<<<test-javadoc-no-fork>>>
+ which will not trigger above phases a second time.
+
+ * Configure this in your <<<reporting>>> section as follows:
+
++-----+
+<project>
+ ...
+ <reporting>
+ <excludeDefaults>true</excludeDefaults>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${project.version}</version>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <report>javadoc-no-fork</report>
+ <report>test-javadoc-no-fork</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ </reporting>
+ ...
+</project>
++-----+
+
+ <<Note>>: These reports may not be used for aggregate reports.
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt.vm?rev=1579407&r1=1579406&r2=1579407&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt.vm
(original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/index.apt.vm Wed Mar
19 21:22:30 2014
@@ -48,7 +48,7 @@ javadoc.exe(or .sh) @options @packages |
* Goals Overview
- The Javadoc Plugin has ten goals:
+ The Javadoc Plugin has twelve goals:
* {{{./javadoc-mojo.html}javadoc:javadoc}} generates the Javadoc files for
the project. It executes the standard
Javadoc tool and supports the parameters used by the tool.
@@ -56,6 +56,16 @@ javadoc.exe(or .sh) @options @packages |
* {{{./test-javadoc-mojo.html}javadoc:test-javadoc}} generates the test
Javadoc files for the project. It executes
the standard Javadoc tool and supports the parameters used by the tool.
+ * {{{./javadoc-nofork-mojo.html}javadoc:javadoc-nofork}} generates the
Javadoc files for the project.
+ It executes the standard Javadoc tool and supports the parameters used by
the tool without forking the
+ <<<generate-sources>>> phase again. Note that this goal does require
generation of test sources before site generation, e.g.
+ by invoking <<<mvn clean deploy site>>>.
+
+ * {{{./test-javadoc-nofork-mojo.html}javadoc:test-javadoc-nofork}}
generates the test Javadoc files for the project.
+ It executes the standard Javadoc tool and supports the parameters used by
the tool without forking the
+ <<<generate-test-sources>>> phase again. Note that this goal does require
generation of test sources before site generation,
+ e.g. by invoking <<<mvn clean deploy site>>>.
+
* {{{./aggregate-mojo.html}javadoc:aggregate}} generates the Javadoc files
for an aggregator project. It executes
the standard Javadoc tool and supports the parameters used by the tool.
@@ -138,4 +148,6 @@ javadoc.exe(or .sh) @options @packages |
* {{{./examples/fix-javadocs.html}Fixing Javadoc Comments}}
+ * {{{./examples/javadoc-nofork.html}Generate Javadoc without duplicate
execution of phase generate-sources}}
+
[]
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml?rev=1579407&r1=1579406&r2=1579407&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml Wed Mar 19
21:22:30 2014
@@ -51,6 +51,7 @@ under the License.
<item name="Selective Javadocs Reports"
href="/examples/selective-javadocs-report.html"/>
<item name="Fixing Javadoc Comments" href="/examples/fix-javadocs.html"/>
<item name="Adding additionnal dependencies"
href="/examples/additionnal-dependencies.html"/>
+ <item name="Generate Javadoc without duplicate execution of phase
generate-sources" href="/examples/javadoc-nofork.html"/>
</menu>
</body>
</project>
