Author: sebb
Date: Fri May 20 12:24:04 2016
New Revision: 1744724
URL: http://svn.apache.org/viewvc?rev=1744724&view=rev
Log:
Javadoc fixes
Modified:
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/cli/Digest.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
Modified:
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/cli/Digest.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/cli/Digest.java?rev=1744724&r1=1744723&r2=1744724&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/cli/Digest.java
(original)
+++
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/cli/Digest.java
Fri May 20 12:24:04 2016
@@ -47,7 +47,7 @@ public class Digest {
* {@code args[0]} is one of {@link MessageDigestAlgorithms}
name, {@link MessageDigest} name, {@code ALL}
* , or {@code *}.
* {@code args[1+]} is a FILE/DIRECTORY/String.
- * @throws IOException
+ * @throws IOException if an error occurs
*/
public static void main(String[] args) throws IOException {
new Digest(args).run();
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=1744724&r1=1744723&r2=1744724&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
Fri May 20 12:24:04 2016
@@ -41,14 +41,12 @@ import org.apache.commons.codec.binary.S
* Note: the class has short-hand methods for all the algorithms present as
standard in Java 6.
* This approach requires lots of methods for each algorithm, and quickly
becomes unwieldy.
* The following code works with all algorithms:
- * <code>
* <pre>
* import static
org.apache.commons.codec.digest.MessageDigestAlgorithms.SHA_224;
* ...
* byte [] digest = DigestUtils.with(SHA_224).update(dataToDigest).done();
* String hdigest = DigestUtils.with(SHA_224).update(new
File("pom.xml")).asHex();
* </pre>
- * </code>
* @see MessageDigestAlgorithms
* @version $Id$
*/
@@ -64,8 +62,6 @@ public class DigestUtils {
* @param data
* Data to digest
* @return the digest
- * @throws IOException
- * On error reading from the stream
* @since 1.11
*/
public static byte[] digest(final MessageDigest messageDigest, final
byte[] data) {
@@ -979,7 +975,7 @@ public static byte[] sha(final byte[] da
* Returns a fluent instance for the digest algorithm.
* Does not reset the digest before use.
* @param digest the digest instance to use
- * @return
+ * @return the fluent instance
*/
public static DigestUtils with(MessageDigest digest) {
return new DigestUtils(digest);
@@ -989,7 +985,7 @@ public static byte[] sha(final byte[] da
* Creates a {@link MessageDigest} and returns a fluent instance.
*
* @param name the name of digest algorithm to create, e.g. {@link
MessageDigestAlgorithms#MD5}
- * @return
+ * @return the fluent instance
*/
public static DigestUtils with(String name) {
return new DigestUtils(getDigest(name));
Modified:
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/HmacUtils.java?rev=1744724&r1=1744723&r2=1744724&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
(original)
+++
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
Fri May 20 12:24:04 2016
@@ -178,7 +178,7 @@ public final class HmacUtils {
* @see Mac#init(Key)
* @throws IllegalArgumentException
* when a {@link NoSuchAlgorithmException} is caught or key is
null or key is invalid.
- * @deprecated Use {@link HmacAlgorithms#getInitializedMac(byte[])}.
+ * @deprecated Use {@link HmacAlgorithms#getHmac(byte[])}.
*/
@Deprecated
public static Mac getInitializedMac(final HmacAlgorithms algorithm, final
byte[] key) {
@@ -873,7 +873,7 @@ public final class HmacUtils {
* key must be provided using the {@link #key(byte[])} method
* before it can be used further.
*
- * @param algorithm to be used.
+ * @param mac the {@link Mac} to be used.
* @return the instance
* @since 1.11
*/
Modified:
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java?rev=1744724&r1=1744723&r2=1744724&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java
(original)
+++
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java
Fri May 20 12:24:04 2016
@@ -288,7 +288,7 @@ public class MatchRatingApproachEncoder
*
* @param name1
* name2
- * @return
+ * @return the length as above
*/
int leftToRightThenRightToLeftProcessing(final String name1, final String
name2) {
final char[] name1Char = name1.toCharArray();
Modified:
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java?rev=1744724&r1=1744723&r2=1744724&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
(original)
+++
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
Fri May 20 12:24:04 2016
@@ -66,13 +66,13 @@ import org.apache.commons.codec.StringEn
* splitting on pipe (<code>|</code>) and indexing under each of these
alternatives.
* <p>
* <b>Note</b>: this version of the Beider-Morse encoding is equivalent with
v3.4 of the reference implementation.
- *
+ * </p>
* @see <a href="http://stevemorse.org/phonetics/bmpm.htm";>Beider-Morse
Phonetic Matching</a>
* @see <a href="http://stevemorse.org/phoneticinfo.htm";>Reference
implementation</a>
*
* <p>
* This class is Not ThreadSafe
- *
+ * </p>
* @since 1.6
* @version $Id$
*/
