Skip to content

Commit d074877

Browse files
committed
Fix malformed Javadoc comments
1 parent 75da1d9 commit d074877

File tree

8 files changed

+28
-27
lines changed

8 files changed

+28
-27
lines changed

src/changes/changes.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ The <action> type attribute can be add,update,fix,remove.
4747
<!-- FIX -->
4848
<action type="fix" dev="ggregory" due-to="Gary Gregory">Fix oak leaf icon references in overview.html when running `mvn clean javadoc:javadoc`.</action>
4949
<action type="fix" dev="ggregory" due-to="Gary Gregory">Fix Apache RAT plugin console warnings.</action>
50+
<action type="fix" dev="ggregory" due-to="Gary Gregory">Fix malformed Javadoc comments.</action>
5051
<!-- ADD -->
5152
<!-- UPDATE -->
5253
<action type="update" dev="ggregory" due-to="Gary Gregory, Dependabot">Bump org.apache.commons:commons-parent from 91 to 93 #415, #418.</action>

src/main/java/org/apache/commons/codec/binary/Base32InputStream.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@
3838
* unused from the final character or entire characters. The default mode is lenient decoding.
3939
* </p>
4040
* <ul>
41-
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.
41+
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.</li>
4242
* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if trailing bits are not part of a valid encoding. Any unused bits from the final
43-
* character must be zero. Impossible counts of entire final characters are not allowed.
43+
* character must be zero. Impossible counts of entire final characters are not allowed.</li>
4444
* </ul>
4545
* <p>
4646
* When strict decoding is enabled it is expected that the decoded bytes will be re-encoded to a byte array that matches the original, i.e. no changes occur on

src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@
4242
* unused from the final character or entire characters. The default mode is lenient decoding.
4343
* </p>
4444
* <ul>
45-
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.
45+
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.</li>
4646
* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if trailing bits are not part of a valid encoding. Any unused bits from the final
47-
* character must be zero. Impossible counts of entire final characters are not allowed.
47+
* character must be zero. Impossible counts of entire final characters are not allowed.</li>
4848
* </ul>
4949
* <p>
5050
* When strict decoding is enabled it is expected that the decoded bytes will be re-encoded to a byte array that matches the original, i.e. no changes occur on

src/main/java/org/apache/commons/codec/binary/Base64InputStream.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@
4242
* unused from the final character or entire characters. The default mode is lenient decoding.
4343
* </p>
4444
* <ul>
45-
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.
45+
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.</li>
4646
* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if trailing bits are not part of a valid encoding. Any unused bits from the final
47-
* character must be zero. Impossible counts of entire final characters are not allowed.
47+
* character must be zero. Impossible counts of entire final characters are not allowed.</li>
4848
* </ul>
4949
* <p>
5050
* When strict decoding is enabled it is expected that the decoded bytes will be re-encoded to a byte array that matches the original, i.e. no changes occur on

src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@
4646
* unused from the final character or entire characters. The default mode is lenient decoding.
4747
* </p>
4848
* <ul>
49-
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.
49+
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.</li>
5050
* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if trailing bits are not part of a valid encoding. Any unused bits from the final
51-
* character must be zero. Impossible counts of entire final characters are not allowed.
51+
* character must be zero. Impossible counts of entire final characters are not allowed.</li>
5252
* </ul>
5353
* <p>
5454
* When strict decoding is enabled it is expected that the decoded bytes will be re-encoded to a byte array that matches the original, i.e. no changes occur on

src/main/java/org/apache/commons/codec/binary/BaseNCodec.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@
3838
* unused from the final character or entire characters. The default mode is lenient decoding.
3939
* </p>
4040
* <ul>
41-
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.
41+
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.</li>
4242
* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if trailing bits are not part of a valid encoding. Any unused bits from the final
43-
* character must be zero. Impossible counts of entire final characters are not allowed.
43+
* character must be zero. Impossible counts of entire final characters are not allowed.</li>
4444
* </ul>
4545
* <p>
4646
* When strict decoding is enabled it is expected that the decoded bytes will be re-encoded to a byte array that matches the original, i.e. no changes occur on
@@ -463,9 +463,9 @@ private static byte[] resizeBuffer(final Context context, final int minCapacity)
463463
* Defines the decoding behavior when the input bytes contain leftover trailing bits that cannot be created by a valid encoding. These can be bits that are
464464
* unused from the final character or entire characters. The default mode is lenient decoding. Set this to {@code true} to enable strict decoding.
465465
* <ul>
466-
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.
466+
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.</li>
467467
* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if trailing bits are not part of a valid encoding. Any unused bits from the final
468-
* character must be zero. Impossible counts of entire final characters are not allowed.
468+
* character must be zero. Impossible counts of entire final characters are not allowed.</li>
469469
* </ul>
470470
* <p>
471471
* When strict decoding is enabled it is expected that the decoded bytes will be re-encoded to a byte array that matches the original, i.e. no changes occur

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,11 @@ public static String crypt(final String key) {
114114
* The exact algorithm depends on the format of the salt string:
115115
* </p>
116116
* <ul>
117-
* <li>SHA-512 salts start with {@code $6$} and are up to 16 chars long.
118-
* <li>SHA-256 salts start with {@code $5$} and are up to 16 chars long
119-
* <li>MD5 salts start with {@code $1$} and are up to 8 chars long
120-
* <li>DES, the traditional UnixCrypt algorithm is used with only 2 chars
121-
* <li>Only the first 8 chars of the passwords are used in the DES algorithm!
117+
* <li>SHA-512 salts start with {@code $6$} and are up to 16 chars long.</li>
118+
* <li>SHA-256 salts start with {@code $5$} and are up to 16 chars long</li>
119+
* <li>MD5 salts start with {@code $1$} and are up to 8 chars long</li>
120+
* <li>DES, the traditional UnixCrypt algorithm is used with only 2 chars</li>
121+
* <li>Only the first 8 chars of the passwords are used in the DES algorithm!</li>
122122
* </ul>
123123
* <p>
124124
* The magic strings {@code "$apr1$"} and {@code "$2a$"} are not recognized by this method as its output should be
@@ -140,10 +140,10 @@ public static String crypt(final String key) {
140140
* The total length is dependent on the algorithm used:
141141
* </p>
142142
* <ul>
143-
* <li>SHA-512: 106 chars
144-
* <li>SHA-256: 63 chars
145-
* <li>MD5: 34 chars
146-
* <li>DES: 13 chars
143+
* <li>SHA-512: 106 chars</li>
144+
* <li>SHA-256: 63 chars</li>
145+
* <li>MD5: 34 chars</li>
146+
* <li>DES: 13 chars</li>
147147
* </ul>
148148
* <p>
149149
* Example:

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,16 @@
4242
* The main differences compared to the other Soundex variants are:
4343
* </p>
4444
* <ul>
45-
* <li>coded names are 6 digits long
46-
* <li>the initial character of the name is coded
47-
* <li>rules to encoded multi-character n-grams
48-
* <li>multiple possible encodings for the same name (branching)
45+
* <li>coded names are 6 digits long</li>
46+
* <li>the initial character of the name is coded</li>
47+
* <li>rules to encoded multi-character n-grams</li>
48+
* <li>multiple possible encodings for the same name (branching)</li>
4949
* </ul>
5050
* <p>
5151
* This implementation supports branching, depending on the used method:
5252
* <ul>
53-
* <li>{@link #encode(String)} - branching disabled, only the first code will be returned
54-
* <li>{@link #soundex(String)} - branching enabled, all codes will be returned, separated by '|'
53+
* <li>{@link #encode(String)} - branching disabled, only the first code will be returned</li>
54+
* <li>{@link #soundex(String)} - branching enabled, all codes will be returned, separated by '|'</li>
5555
* </ul>
5656
* <p>
5757
* Note: This implementation has additional branching rules compared to the original description of the algorithm. The

0 commit comments

Comments
 (0)