Author: dkulp
Date: Fri Mar 23 10:18:58 2007
New Revision: 521818
URL: http://svn.apache.org/viewvc?view=rev&rev=521818
Log:
Updates to the docs
Modified:
maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/BundleRemoteResourcesMojo.java
maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java
Modified:
maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/BundleRemoteResourcesMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/BundleRemoteResourcesMojo.java?view=diff&rev=521818&r1=521817&r2=521818
==============================================================================
---
maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/BundleRemoteResourcesMojo.java
(original)
+++
maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/BundleRemoteResourcesMojo.java
Fri Mar 23 10:18:58 2007
@@ -35,8 +35,7 @@
import java.io.FileWriter;
/**
- * Pull down artifacts containing remote resources and process the resources
contained
- * inside the artifact.
+ * Bundle up the resources that should be considered as a remote-resource
*
* @goal bundle
* @phase generate-resources
@@ -69,11 +68,11 @@
/**
* A list of files to include. Can contain ant-style wildcards and double
wildcards.
- * The default includes are
+ * The default includes are
* <code>**/*.txt **/*.vm</code>
*
* @parameter
- * @Since 1.0-alpha-5
+ * @since 1.0-alpha-5
*/
private String[] includes;
@@ -81,7 +80,7 @@
* A list of files to exclude. Can contain ant-style wildcards and double
wildcards.
*
* @parameter
- * @Since 1.0-alpha-5
+ * @since 1.0-alpha-5
*/
private String[] excludes;
Modified:
maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java?view=diff&rev=521818&r1=521817&r2=521818
==============================================================================
---
maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java
(original)
+++
maven/plugins/trunk/maven-remote-resources-plugin/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java
Fri Mar 23 10:18:58 2007
@@ -65,6 +65,12 @@
/**
* Pull down resourceBundles containing remote resources and process the
resources contained
* inside the artifact.
+ * <p/>
+ * Resources that end in ".vm" are treated as velocity templates. For those,
the ".vm" is
+ * stripped off for the final artifact name and it's fed through velocity to
have properties
+ * expanded, conditions processed, etc...
+ * <p/>
+ * Resources that don't end in ".vm" are copied "as is".
*
* @goal process
* @requiresDependencyResolution runtime
@@ -119,12 +125,12 @@
/**
* Additional properties to be passed to velocity.
- *
- * Several properties are automatically added:
- * project - the current MavenProject
- * projects - the list of dependency projects
- * projectTimespan - the timespan of the current project (requires
inceptionYear in pom)
- *
+ * <p/>
+ * Several properties are automatically added:<br/>
+ * project - the current MavenProject <br/>
+ * projects - the list of dependency projects<br/>
+ * projectTimespan - the timespan of the current project (requires
inceptionYear in pom)<br/>
+ * <p/>
* See <a
href="http://maven.apache.org/ref/current/maven-project/apidocs/org/apache/maven/project/MavenProject.html";>
* the javadoc for MavenProject</a> for information about the properties
on the MavenProject.
*
