[CODEC-328] Clarify Javadoc for

org.apache.commons.codec.digest.UnixCrypt.crypt(byte[],String)

Author: garydgregory

src/changes/changes.xml

@@ -47,6 +47,7 @@ The <action> type attribute can be add,update,fix,remove.
       <!-- FIX -->
       <action type="fix" dev="ggregory" due-to="Gary Gregory">Remove -nouses directive from maven-bundle-plugin. OSGi package imports now state 'uses' definitions for package imports, this doesn't affect JPMS (from org.apache.commons:commons-parent:80).</action>
       <action type="fix" dev="ggregory" due-to="Gary Gregory">Refactor DigestUtils.updateDigest(MessageDigest, File) to use NIO.</action>
+      <action type="fix" dev="ggregory" due-to="Gary Gregory" issue="CODEC-328" >Clarify Javadoc for org.apache.commons.codec.digest.UnixCrypt.crypt(byte[],String).</action>
       <!-- ADD -->
       <action type="add" dev="ggregory" due-to="Gary Gregory">Add HmacUtils.hmac(Path).</action>      
       <action type="add" dev="ggregory" due-to="Gary Gregory">Add HmacUtils.hmacHex(Path).</action>      

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

@@ -236,14 +236,11 @@ public static String crypt(final byte[] original) {
      * Using unspecified characters as salt results incompatible hash values.
      * </p>
      *
-     * @param original
-     *            plaintext password
-     * @param salt
-     *            a two character string drawn from [a-zA-Z0-9./]. The salt may be null, in which case a salt is
-     *            generated for you using {@link B64#getRandomSalt(int)}.
+     * @param original plaintext password
+     * @param salt     a two character string drawn from [a-zA-Z0-9./]. The salt may be null, in which case a salt is generated for you using
+     *                 {@link B64#getRandomSalt(int)}. Only the first two characters are used, others are ignored.
      * @return a 13 character string starting with the salt string
-     * @throws IllegalArgumentException
-     *             if the salt does not match the allowed pattern
+     * @throws IllegalArgumentException if the salt does not match the allowed pattern
      */
     public static String crypt(final byte[] original, String salt) {
         if (salt == null) {