Author: mperham
Date: Tue Jan 10 10:14:16 2006
New Revision: 367710
URL: http://svn.apache.org/viewcvs?rev=367710&view=rev
Log:
PR: MJAVADOC-2 Update plugin docs
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/configuration.apt
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/configuration.apt
URL:
http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/configuration.apt?rev=367710&r1=367709&r2=367710&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/configuration.apt
(original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/configuration.apt Tue
Jan 10 10:14:16 2006
@@ -9,8 +9,33 @@
Javadoc Plugin Configuration
- Add configuration similar to the following to your POM:
+ To generate the project javadocs as part of the site generation, add
configuration
+ similar to the following to your POM:
+-------------------
+<project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <minmemory>128m</minmemory>
+ <maxmemory>512</maxmemory>
+ ...
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </reporting>
+ ...
+</project>
+-------------------
+
+ The configuration within <reporting> is not used when javadoc is explicitly
invoked
+ via 'mvn javadoc:javadoc'. To configure explicit invocation, use the
<build> element instead:
+
-------------------
<project>
...
