Author: sebb
Date: Tue May 17 22:09:52 2016
New Revision: 1744326
URL: http://svn.apache.org/viewvc?rev=1744326&view=rev
Log:
Javadoc
Modified:
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
Modified:
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/DigestUtils.java?rev=1744326&r1=1744325&r2=1744326&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
(original)
+++
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
Tue May 17 22:09:52 2016
@@ -32,7 +32,11 @@ import org.apache.commons.codec.binary.S
/**
* Operations to simplify common {@link java.security.MessageDigest} tasks.
* This class is immutable and thread-safe.
- *
+ * However the MessageDigest instances it creates generally won't be.
+ * <p>
+ * The {@link MessageDigestAlgorithms} class provides constants for standard
+ * digest algorithms that can be used with the {@link #getDigest(String)}
method.
+ * @see MessageDigestAlgorithms
* @version $Id$
*/
public class DigestUtils {
@@ -40,7 +44,7 @@ public class DigestUtils {
private static final int STREAM_BUFFER_LENGTH = 1024;
/**
- * Read through an ByteBuffer and returns the digest for the data.
Provided for symmetry with other methods.
+ * Read through a byte array and returns the digest for the data. Provided
for symmetry with other methods.
*
* @param messageDigest
* The MessageDigest to use (e.g. MD5)
