svn commit: r1384980 - /maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt.vm

[bi...@apache.org]

Author: bimargulies
Date: Sat Sep 15 00:19:20 2012
New Revision: 1384980

URL: http://svn.apache.org/viewvc?rev=1384980&view=rev
Log:
MJAVADOC-296: explain resources directory
o added some more explanation.

Modified:
    maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.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=1384980&r1=1384979&r2=1384980&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 Sat Sep 15 00:19:20 2012
@@ -28,8 +28,10 @@
 
 Using Javadoc Resources
 
- The {{{../javadoc-mojo.html#javadocDirectory}\<javadocDirectory/\>}} parameter can be used to include Javadoc
- resources like HTML or images. By default, all javadoc resources are in <$\{basedir\}/src/main/javadoc> directory.
+ The {{{../javadoc-mojo.html#javadocDirectory}\<javadocDirectory/\>}} 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 <$\{basedir\}/src/main/javadoc> directory. Note that you need to set the
+ docfilessubdirs parameter to copy these.
 
  Here is a typical set of resources files used by the Maven Javadoc plugin: