You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2009/08/19 12:31:25 UTC
svn commit: r805737 - in
/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples:
javadoc-resources.apt.vm test-javadocs.apt.vm
Author: vsiveton
Date: Wed Aug 19 10:31:24 2009
New Revision: 805737
URL: http://svn.apache.org/viewvc?rev=805737&view=rev
Log:
MJAVADOC-247: location of doc-files is wrong on page http://maven.apache.org/plugins/maven-javadoc-plugin/examples/test-javadocs.html
o clarify notes
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/test-javadocs.apt.vm
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt.vm?rev=805737&r1=805736&r2=805737&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt.vm (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt.vm Wed Aug 19 10:31:24 2009
@@ -3,7 +3,7 @@
------
Vincent Siveton
------
- 2009-08-04
+ 2009-08-19
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -162,5 +162,5 @@
}
+-----+
- <<Note>>: You need to run the Javadoc Plugin with the <<<docfilessubdirs>>> parameter to allow the copy of
- unprocessed files.
+ <<IMPORTANT NOTE>>: To allow the copy of unprocessed files, you need to run the Javadoc Plugin with the
+ <<<{{{../javadoc-mojo.html#docfilessubdirs}\<docfilessubdirs/\>}}>>> parameter.
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/test-javadocs.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/test-javadocs.apt.vm?rev=805737&r1=805736&r2=805737&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/test-javadocs.apt.vm (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/test-javadocs.apt.vm Wed Aug 19 10:31:24 2009
@@ -3,7 +3,7 @@
------
Vincent Siveton
------
- 2009-08-04
+ 2009-08-19
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -34,6 +34,8 @@
* using the \<reportSets/\> configuration parameter
+ []
+
Here is a typical project used by the Maven Javadoc plugin:
+-----+
@@ -102,12 +104,19 @@
You could call <mvn javadoc:test-javadoc> or <mvn site>. See
{{{../test-javadoc-mojo.html}javadoc:test-javadoc parameters}} for more informations.
- <<Note>>: If you don't set \<testDoctitle/\> or \<testWindowtitle/\> parameters, the Test Javadoc report use the same
+ <<Notes>>:
+
+ [[1]] If you don't set \<testDoctitle/\> or \<testWindowtitle/\> parameters, the Test Javadoc report use the same
configuration (i.e. \<doctitle/\> or \<windowtitle/\> parameters) that Javadoc report (backward compatible reasons).
- <<Note>>: To run the reports selectively, you need to include only the reports that you prefer.
+ [[2]] To run the reports selectively, you need to include only the reports that you prefer.
Read the {{{./selective-javadocs-report.html}Selective Javadocs Reports}} part for more information.
+ [[3]] To allow the copy of resources, you need to add the \<docfilessubdirs/\> parameter. Read the
+ {{{./javadoc-resources.html}Using Javadoc Resources}} page for more information.
+
+ []
+
* Using the \<reportSets/\> configuration parameter
You could also want a different kind of configuration for the Javadoc report and the test Javadoc report.