svn commit: r684727 - in /maven/plugins/trunk/maven-javadoc-plugin/src: main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java site/apt/examples/javadoc-resources.apt

[vsiveton]

Author: vsiveton
Date: Mon Aug 11 04:55:20 2008
New Revision: 684727

URL: http://svn.apache.org/viewvc?rev=684727&view=rev
Log:
o improved doc due to questions on dev@

Modified:
    
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
    
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt

Modified: 
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java?rev=684727&r1=684726&r2=684727&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
 (original)
+++ 
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
 Mon Aug 11 04:55:20 2008
@@ -248,9 +248,14 @@
 
     /**
      * Specifies the Javadoc resources directory to be included in the Javadoc 
(i.e. package.html, images...).
+     * <br/>
+     * Could be used in addition of <code>docfilessubdirs</code> parameter.
+     * <br/>
+     * See <a href="#docfilessubdirs">docfilessubdirs</a>.
      *
      * @since 2.1
      * @parameter expression="${basedir}/src/main/javadoc"
+     * @see #docfilessubdirs
      */
     private File javadocDirectory;
 
@@ -763,8 +768,12 @@
      * <br/>
      * Since <a 
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary";>Java
 1.4</a>.
      * <br/>
+     * See <a href="#javadocDirectory">javadocDirectory</a>.
+     * <br/>
      *
      * @parameter expression="${docfilessubdirs}" default-value="false"
+     * @see #excludedocfilessubdir
+     * @see #javadocDirectory
      */
     private boolean docfilessubdirs;
 
@@ -788,6 +797,7 @@
      * Since <a 
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary";>Java
 1.4</a>.
      *
      * @parameter expression="${excludedocfilessubdir}"
+     * @see #docfilessubdirs
      */
     private String excludedocfilessubdir;
 

Modified: 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt?rev=684727&r1=684726&r2=684727&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt
 (original)
+++ 
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt
 Mon Aug 11 04:55:20 2008
@@ -3,7 +3,7 @@
  ------
  Vincent Siveton
  ------
- 2008-07-31
+ 2008-08-11
  ------
 
 ~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -124,7 +124,7 @@
 </HTML>
 +-----+
 
- <<Note:>> With Javadoc 5.0, this file becomes <package-info.java> and is 
preferred over <package.html>.
+ <<Note>>: With Javadoc 5.0, this file becomes <package-info.java> and is 
preferred over <package.html>.
 
  For more information, see 
{{{http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#packagecomment}
  javadoc - The Java API Documentation Generator, Package Comment Files}}.
@@ -160,3 +160,6 @@
 {
 }
 +-----+
+
+ <<Note>>: You need to run the Javadoc Plugin with the <<<docfilessubdirs>>> 
parameter to allow the copy of
+ unprocessed files.