svn commit: r806391 - /maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java

[jd...@apache.org]

Author: jdcasey
Date: Thu Aug 20 22:55:01 2009
New Revision: 806391

URL: http://svn.apache.org/viewvc?rev=806391&view=rev
Log:
some documentation of the delimiters set.

Modified:
    maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java

Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java?rev=806391&r1=806390&r2=806391&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java Thu Aug 20 22:55:01 2009
@@ -68,6 +68,10 @@
     private boolean injectProjectBuildFilters = false;
     
     /**
+     * Set of expression delimiter specifications to use during filtering. Delimiter specifications are
+     * given in the form 'BEGIN*END' or, for symmetical delimiters, simply 'TOKEN'. The default
+     * values are '${*}' and '@'.
+     * 
      * @since 1.0-beta-3
      */
     private Set delimiters = new HashSet();
@@ -241,6 +245,7 @@
     }
 
     /**
+     * See {@link AbstractMavenFilteringRequest#delimiters} for more information and default values.
      * @return Not allowed to be null or empty.
      * @since 1.0-beta-3
      */
@@ -250,7 +255,11 @@
     }
 
     /**
-     * @param delimiters If null, reset delimiters to ${*} only. Otherwise, use the provided parameter value.
+     * Set the delimiter specifications to use during filtering. Specifications should be of the form:
+     * 'BEGIN*END' for asymmetical delimiters, or 'TOKEN' for symmetical delimiters. See
+     * {@link AbstractMavenFilteringRequest#delimiters} for more information and default values.
+     * 
+     * @param delimiters If null, reset delimiters to '${*}' only. Otherwise, use the provided parameter value.
      * @since 1.0-beta-3
      */
     public void setDelimiters( Set delimiters )