Javadoc fixes

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1744724 13f79535-47bb-0310-9956-ffa450edef68

Author: sebbASF

src/main/java/org/apache/commons/codec/cli/Digest.java

@@ -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();

src/main/java/org/apache/commons/codec/digest/DigestUtils.java

@@ -41,14 +41,12 @@
  * 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 @@ private DigestUtils(MessageDigest digest) {
      * 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 DigestUtils with(MessageDigest digest) {
      * 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));

src/main/java/org/apache/commons/codec/digest/HmacUtils.java

@@ -178,7 +178,7 @@ public static Mac getHmacSha512(final byte[] key) {
      * @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 @@ private HmacUtils(final Mac mac) {
      * 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
      */

src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java

@@ -288,7 +288,7 @@ boolean isVowel(final String letter) {
      *
      * @param name1
      *            name2
-     * @return
+     * @return the length as above
      */
     int leftToRightThenRightToLeftProcessing(final String name1, final String name2) {
         final char[] name1Char = name1.toCharArray();

src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java

@@ -66,13 +66,13 @@
  * 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$
  */