Skip to content

Commit 2fa5d5c

Browse files
committed
Use @code in Javadoc. Typo.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1635204 13f79535-47bb-0310-9956-ffa450edef68
1 parent 9164cd8 commit 2fa5d5c

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

  • src/main/java/org/apache/commons/codec/digest

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -97,26 +97,26 @@ public static String crypt(final String key) {
9797
* <p>
9898
* The exact algorithm depends on the format of the salt string:
9999
* <ul>
100-
* <li>SHA-512 salts start with $6$ and are up to 16 chars long.
101-
* <li>SHA-256 salts start with $5$ and are up to 16 chars long
102-
* <li>MD5 salts start with "$1$" and are up to 8 chars long
100+
* <li>SHA-512 salts start with {@code $6$} and are up to 16 chars long.
101+
* <li>SHA-256 salts start with {@code $5$} and are up to 16 chars long
102+
* <li>MD5 salts start with {@code $1$} and are up to 8 chars long
103103
* <li>DES, the traditional UnixCrypt algorithm is used else with only 2 chars
104104
* <li>Only the first 8 chars of the passwords are used in the DES algorithm!
105105
* </ul>
106-
* The magic strings "$apr1$" and "$2a$" are not recognised by this method as its output should be identical with
107-
* that of the libc implementation.
106+
* The magic strings {@code "$apr1$"} and {@code "$2a$"} are not recognized by this method as its output should be
107+
* identical with that of the libc implementation.
108108
* <p>
109-
* The rest of the salt string is drawn from the set [a-zA-Z0-9./] and is cut at the maximum length of if a "$"
110-
* sign is encountered. It is therefore valid to enter a complete hash value as salt to e.g. verify a password
111-
* with:
109+
* The rest of the salt string is drawn from the set {@code [a-zA-Z0-9./]} and is cut at the maximum length of if a
110+
* {@code "$"} sign is encountered. It is therefore valid to enter a complete hash value as salt to e.g. verify a
111+
* password with:
112112
*
113113
* <pre>
114114
* storedPwd.equals(crypt(enteredPwd, storedPwd))
115115
* </pre>
116116
* <p>
117-
* The resulting string starts with the marker string ($6$), continues with the salt value and ends with a "$" sign
118-
* followed by the actual hash value. For DES the string only contains the salt and actual hash. It's total length
119-
* is dependent on the algorithm used:
117+
* The resulting string starts with the marker string ({@code $6$}), continues with the salt value and ends with a
118+
* {@code "$"} sign followed by the actual hash value. For DES the string only contains the salt and actual hash.
119+
* It's total length is dependent on the algorithm used:
120120
* <ul>
121121
* <li>SHA-512: 106 chars
122122
* <li>SHA-256: 63 chars

0 commit comments

Comments
 (0)