commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1494812 - /commons/sandbox/commons-digest-plugin/trunk/src/main/java/org/apache/commons/plugins/digest/DigestMojo.java
Date Thu, 20 Jun 2013 00:00:41 GMT
Author: sebb
Date: Thu Jun 20 00:00:41 2013
New Revision: 1494812

URL: http://svn.apache.org/r1494812
Log:
Javadoc

Modified:
    commons/sandbox/commons-digest-plugin/trunk/src/main/java/org/apache/commons/plugins/digest/DigestMojo.java

Modified: commons/sandbox/commons-digest-plugin/trunk/src/main/java/org/apache/commons/plugins/digest/DigestMojo.java
URL: http://svn.apache.org/viewvc/commons/sandbox/commons-digest-plugin/trunk/src/main/java/org/apache/commons/plugins/digest/DigestMojo.java?rev=1494812&r1=1494811&r2=1494812&view=diff
==============================================================================
--- commons/sandbox/commons-digest-plugin/trunk/src/main/java/org/apache/commons/plugins/digest/DigestMojo.java
(original)
+++ commons/sandbox/commons-digest-plugin/trunk/src/main/java/org/apache/commons/plugins/digest/DigestMojo.java
Thu Jun 20 00:00:41 2013
@@ -32,14 +32,13 @@ import org.apache.maven.project.MavenPro
 import org.codehaus.plexus.util.DirectoryScanner;
 
 /**
- * Creates digests for files.
+ * Creates digests (MD5 and SHA1 by default) for files specified
+ * by the configured includes and excludes.
+ * Also allows specification of a list of files on the command line.
  */
 @Mojo( name = "digest")
 public class DigestMojo extends AbstractMojo {
 
-    /**
-     * The maven project.
-     */
     @Component
     private MavenProject project;
 
@@ -68,19 +67,19 @@ public class DigestMojo extends Abstract
     private String files;
 
     /**
-     * Create the MD5 hash.
+     * Whether to create the MD5 hash, default {@code true}
      */
     @Parameter( property = "digest.md5", defaultValue = "true" )
     private boolean createMD5;
 
     /**
-     * Create the SHA1 hash.
+     * Whether to create the SHA1 hash, default {@code true}
      */
     @Parameter( property = "digest.sha1", defaultValue = "true" )
     private boolean createSHA1;
 
     /**
-     * Append ' *filename' to the hash
+     * Whether to append ' *filename' to the hash in the generated file, default {@code false}
      */
     @Parameter( property = "digest.appendFilename", defaultValue = "false" )
     private boolean appendFilename;



Mime
View raw message