[maven-mapping] 04/42: Improve Javadoc.

[hb...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-mapping.git

commit 55c5778f084701bd0eed40ca8c7dd49d5c2d937f
Author: Dennis Lundberg <de...@apache.org>
AuthorDate: Fri Aug 9 11:38:38 2013 +0000

    Improve Javadoc.
    
    git-svn-id: https://svn.apache.org/repos/asf/maven/shared/trunk@1512265 13f79535-47bb-0310-9956-ffa450edef68
---
 .../maven/shared/mapping/DashClassifierValueSource.java     |  1 -
 .../java/org/apache/maven/shared/mapping/MappingUtils.java  | 13 ++++++++++---
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/src/main/java/org/apache/maven/shared/mapping/DashClassifierValueSource.java b/src/main/java/org/apache/maven/shared/mapping/DashClassifierValueSource.java
index 8422512..fd7e9fb 100644
--- a/src/main/java/org/apache/maven/shared/mapping/DashClassifierValueSource.java
+++ b/src/main/java/org/apache/maven/shared/mapping/DashClassifierValueSource.java
@@ -29,7 +29,6 @@ import org.codehaus.plexus.interpolation.PropertiesBasedValueSource;
  * <code>dashClassifier?</code>.
  *
  * @version $Id$
- * @since 2.5
  */
 public class DashClassifierValueSource
     extends PropertiesBasedValueSource
diff --git a/src/main/java/org/apache/maven/shared/mapping/MappingUtils.java b/src/main/java/org/apache/maven/shared/mapping/MappingUtils.java
index 991077b..f032612 100644
--- a/src/main/java/org/apache/maven/shared/mapping/MappingUtils.java
+++ b/src/main/java/org/apache/maven/shared/mapping/MappingUtils.java
@@ -25,19 +25,26 @@ import org.codehaus.plexus.interpolation.ObjectBasedValueSource;
 import org.codehaus.plexus.interpolation.RegexBasedInterpolator;
 
 /**
+ * <p>
  * Utilities used to evaluate expression.
- * <p/>
- * TODO: this comes from the assembly plugin; refactor when it's shared.
- * <p/>
+ * </p>
+ * <p>
  * The expression might use any field of the {@link Artifact} interface. Some
  * examples might be:
+ * </p>
  * <ul>
  * <li>@{artifactId}@-@{version}@@{dashClassifier?}@.@{extension}@</li>
  * <li>@{artifactId}@-@{version}@.@{extension}@</li>
  * <li>@{artifactId}@.@{extension}@</li>
  * </ul>
+ * <p>
+ * Although parts of this code comes from the Assembly Plugin, it cannot be
+ * shared with the Assembly Plugin. The reason for this is that the Assembly
+ * Plugin always uses a prefix for the expressions, whereas this code does not.
+ * <p/>
  *
  * @author Stephane Nicoll
+ * @author Dennis Lundberg
  * @version $Id$
  */
 public class MappingUtils

-- 
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.