Skip to content

Commit 466a61d

Browse files
committed
Fix Javadoc
1 parent ca27bd3 commit 466a61d

File tree

1 file changed

+37
-19
lines changed

1 file changed

+37
-19
lines changed

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

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,13 @@
3838
* <a href="https://github.com/aappleby/smhasher">SMHasher</a>:
3939
* </p>
4040
*
41-
* <blockquote> "All MurmurHash versions are public domain software, and the author disclaims all copyright to their
42-
* code." </blockquote>
41+
* <blockquote>
42+
* "All MurmurHash versions are public domain software, and the author disclaims all copyright to their
43+
* code."
44+
* </blockquote>
4345
*
4446
* <p>
45-
* Original adaption from <a href=https://hive.apache.org/">Apache Hive</a>.
47+
* Original adaption from <a href="https://hive.apache.org/">Apache Hive</a>.
4648
* That adaption contains a {@code hash64} method that is not part of the original
4749
* MurmurHash3 code. It is not recommended to use these methods. They will be removed in a future release. To obtain a
4850
* 64-bit hash use half of the bits from the {@code hash128x64} methods using the input data converted to bytes.
@@ -62,12 +64,16 @@ public final class MurmurHash3 {
6264
* Generates 32-bit hash from input bytes. Bytes can be added incrementally and the new
6365
* hash computed.
6466
*
65-
* <p>This is an implementation of the 32-bit hash function {@code MurmurHash3_x86_32}
66-
* from Austin Appleby's original MurmurHash3 {@code c++} code in SMHasher.</p>
67+
* <p>
68+
* This is an implementation of the 32-bit hash function {@code MurmurHash3_x86_32}
69+
* from Austin Appleby's original MurmurHash3 {@code c++} code in SMHasher.
70+
* </p>
6771
*
68-
* <p>This implementation contains a sign-extension bug in the finalization step of
72+
* <p>
73+
* This implementation contains a sign-extension bug in the finalization step of
6974
* any bytes left over from dividing the length by 4. This manifests if any of these
70-
* bytes are negative.</p>
75+
* bytes are negative.
76+
* </p>
7177
*
7278
* @deprecated Use IncrementalHash32x86. This corrects the processing of trailing bytes.
7379
*/
@@ -84,9 +90,11 @@ public IncrementalHash32() {
8490
/**
8591
* {@inheritDoc}
8692
*
87-
* <p>This implementation contains a sign-extension bug in the finalization step of
93+
* <p>
94+
* This implementation contains a sign-extension bug in the finalization step of
8895
* any bytes left over from dividing the length by 4. This manifests if any of these
89-
* bytes are negative.<p>
96+
* bytes are negative.
97+
* <p>
9098
*
9199
* @deprecated Use IncrementalHash32x86. This corrects the processing of trailing bytes.
92100
*/
@@ -121,8 +129,10 @@ int finalise(final int hash, final int unprocessedLength, final byte[] unprocess
121129
* Generates 32-bit hash from input bytes. Bytes can be added incrementally and the new
122130
* hash computed.
123131
*
124-
* <p>This is an implementation of the 32-bit hash function {@code MurmurHash3_x86_32}
125-
* from Austin Appleby's original MurmurHash3 {@code c++} code in SMHasher.</p>
132+
* <p>
133+
* This is an implementation of the 32-bit hash function {@code MurmurHash3_x86_32}
134+
* from Austin Appleby's original MurmurHash3 {@code c++} code in SMHasher.
135+
* </p>
126136
*
127137
* @since 1.14
128138
*/
@@ -406,8 +416,10 @@ private static long getLittleEndianLong(final byte[] data, final int index) {
406416
* int hash = MurmurHash3.hash128(data, offset, data.length, seed);
407417
* </pre>
408418
*
409-
* <p>Note: The sign extension bug in {@link #hash128(byte[], int, int, int)} does not effect
410-
* this result as the default seed is positive.</p>
419+
* <p>
420+
* Note: The sign extension bug in {@link #hash128(byte[], int, int, int)} does not effect
421+
* this result as the default seed is positive.
422+
* </p>
411423
*
412424
* @param data The input byte array
413425
* @return The 128-bit hash (2 longs)
@@ -420,11 +432,15 @@ public static long[] hash128(final byte[] data) {
420432
/**
421433
* Generates 128-bit hash from the byte array with the given offset, length and seed.
422434
*
423-
* <p>This is an implementation of the 128-bit hash function {@code MurmurHash3_x64_128}
424-
* from Austin Appleby's original MurmurHash3 {@code c++} code in SMHasher.</p>
435+
* <p>
436+
* This is an implementation of the 128-bit hash function {@code MurmurHash3_x64_128}
437+
* from Austin Appleby's original MurmurHash3 {@code c++} code in SMHasher.
438+
* </p>
425439
*
426-
* <p>This implementation contains a sign-extension bug in the seed initialization.
427-
* This manifests if the seed is negative.</p>
440+
* <p>
441+
* This implementation contains a sign-extension bug in the seed initialization.
442+
* This manifests if the seed is negative.
443+
* </p>
428444
*
429445
* @param data The input byte array
430446
* @param offset The first element of array
@@ -459,8 +475,10 @@ public static long[] hash128(final byte[] data, final int offset, final int leng
459475
* int hash = MurmurHash3.hash128(bytes, offset, bytes.length, seed);
460476
* </pre>
461477
*
462-
* <p>Note: The sign extension bug in {@link #hash128(byte[], int, int, int)} does not effect
463-
* this result as the default seed is positive.</p>
478+
* <p>
479+
* Note: The sign extension bug in {@link #hash128(byte[], int, int, int)} does not effect
480+
* this result as the default seed is positive.
481+
* </p>
464482
*
465483
* @param data The input String
466484
* @return The 128-bit hash (2 longs)

0 commit comments

Comments
 (0)