Author: dennisl
Date: Fri Aug 3 09:19:46 2007
New Revision: 562516
URL: http://svn.apache.org/viewvc?view=rev&rev=562516
Log:
o Improve the documentation about templateDirectory.
Modified:
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/announcement/AnnouncementMojo.java
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/using-a-custom-announcement-template.apt
Modified:
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/announcement/AnnouncementMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/announcement/AnnouncementMojo.java?view=diff&rev=562516&r1=562515&r2=562516
==============================================================================
---
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/announcement/AnnouncementMojo.java
(original)
+++
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/announcement/AnnouncementMojo.java
Fri Aug 3 09:19:46 2007
@@ -152,6 +152,10 @@
/**
* Directory that contains the template.
+ * <p>
+ * <b>Note:</b> This directory must be a subdirectory of
+ * <code>/src/main/resources/</code>.
+ * </p>
*
* @parameter default-value="org/apache/maven/plugin/announcement"
* @required
Modified:
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/using-a-custom-announcement-template.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/using-a-custom-announcement-template.apt?view=diff&rev=562516&r1=562515&r2=562516
==============================================================================
---
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/using-a-custom-announcement-template.apt
(original)
+++
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/using-a-custom-announcement-template.apt
Fri Aug 3 09:19:46 2007
@@ -37,7 +37,10 @@
First you must configure the plugin and tell it where your template is. In
this example we want to use the template
- <<<${basedir}/src/main/resources/our-announcements/my-announcement.vm>>>
+ <<<${basedir}/src/main/resources/our-announcements/my-announcement.vm>>>.
+
+ <<Note:>> The <<<templateDirectory>>> must be a subdirectory of
+ <<<${basedir}/src/main/resources/>>>.
+-----------------+
<project>
