Correct test javadoc headers.

This commit is contained in:
aherbert 2020-02-17 13:44:14 +00:00
parent 1f17189d53
commit 7aaf396c83
17 changed files with 14 additions and 35 deletions

View File

@ -33,8 +33,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.StaticHasher;
import org.junit.Test; import org.junit.Test;
/** /**
* Test standard methods. * Test standard methods in the {@link BloomFilter} interface.
*
*/ */
public abstract class AbstractBloomFilterTest { public abstract class AbstractBloomFilterTest {

View File

@ -27,8 +27,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.StaticHasher;
import org.junit.Test; import org.junit.Test;
/** /**
* Tests for the BitSetBloomFilter implementation. * Tests for the {@link BitSetBloomFilter}.
*
*/ */
public class BitSetBloomFilterTest extends AbstractBloomFilterTest { public class BitSetBloomFilterTest extends AbstractBloomFilterTest {

View File

@ -32,8 +32,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.StaticHasher;
import org.junit.Test; import org.junit.Test;
/** /**
* Tests for the Counting Bloom filter implementation. * Tests for the {@link CountingBloomFilter}.
*
*/ */
public class CountingBloomFilterTest extends AbstractBloomFilterTest { public class CountingBloomFilterTest extends AbstractBloomFilterTest {

View File

@ -25,8 +25,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.Shape;
import org.apache.commons.collections4.bloomfilter.hasher.StaticHasher; import org.apache.commons.collections4.bloomfilter.hasher.StaticHasher;
/** /**
* A test that test all the default implementations on the BloomFilter. * Test all the default implementations of the BloomFilter in {@link AbstractBloomFilter}.
*
*/ */
public class DefaultBloomFilterMethodsTest extends AbstractBloomFilterTest { public class DefaultBloomFilterMethodsTest extends AbstractBloomFilterTest {

View File

@ -26,8 +26,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.function.MD5Cyclic;
import org.junit.Test; import org.junit.Test;
/** /**
* Tests the HasherBloomFilter implementation. * Tests the {@link HasherBloomFilter}.
*
*/ */
public class HasherBloomFilterTest extends AbstractBloomFilterTest { public class HasherBloomFilterTest extends AbstractBloomFilterTest {

View File

@ -27,8 +27,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.StaticHasher;
import org.junit.Test; import org.junit.Test;
/** /**
* Test SetOperations implementation * Test {@link SetOperations}.
*
*/ */
public class SetOperationsTest { public class SetOperationsTest {

View File

@ -30,8 +30,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.HashFunctionIdentity.S
import org.junit.Test; import org.junit.Test;
/** /**
* Tests of the HashFunctionIdentity.COMMON_COMPARATOR * Tests of the {@link HashFunctionIdentity#COMMON_COMPARATOR}.
*
*/ */
public class CommonComparatorTest { public class CommonComparatorTest {

View File

@ -30,8 +30,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.HashFunctionIdentity.S
import org.junit.Test; import org.junit.Test;
/** /**
* Tests of the HashFunctionIdentity.DEEP_COMPARATOR * Tests of the {@link HashFunctionIdentity#DEEP_COMPARATOR}.
*
*/ */
public class DeepComparatorTest { public class DeepComparatorTest {

View File

@ -28,8 +28,7 @@ import org.junit.Before;
import org.junit.Test; import org.junit.Test;
/** /**
* DynamicHasher Builder tests. * {@link DynamicHasher.Builder} tests.
*
*/ */
public class DynamicHasherBuilderTest { public class DynamicHasherBuilderTest {

View File

@ -29,8 +29,7 @@ import org.junit.Before;
import org.junit.Test; import org.junit.Test;
/** /**
* Tests the Dynamic Hasher * Tests the {@link DynamicHasher}.
*
*/ */
public class DynamicHasherTest { public class DynamicHasherTest {
private DynamicHasher.Builder builder; private DynamicHasher.Builder builder;

View File

@ -24,8 +24,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.HashFunctionIdentity.P
import org.junit.Test; import org.junit.Test;
/** /**
* Tests the HashFunctionIdentity implementation. * Tests the HashFunctionIdentity implementation ({@link HashFunctionIdentityImpl})..
*
*/ */
public class HashFunctionIdentityImplTest { public class HashFunctionIdentityImplTest {

View File

@ -28,8 +28,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.Shape;
import org.junit.Test; import org.junit.Test;
/** /**
* Tests that the Shap class. * Tests the {@link Shape} class.
*
*/ */
public class ShapeTest { public class ShapeTest {
@ -225,7 +224,6 @@ public class ShapeTest {
} catch (final IllegalArgumentException expected) { } catch (final IllegalArgumentException expected) {
// do nothing. // do nothing.
} }
try { try {
new Shape(testFunction, 10, 1.0); new Shape(testFunction, 10, 1.0);
fail("Should have thrown IllegalArgumentException"); fail("Should have thrown IllegalArgumentException");
@ -265,7 +263,6 @@ public class ShapeTest {
*/ */
@Test @Test
public void constructor_nm_noName() { public void constructor_nm_noName() {
try { try {
new Shape(null, 5, 72); new Shape(null, 5, 72);
fail("Should throw NullPointerException"); fail("Should throw NullPointerException");
@ -279,7 +276,6 @@ public class ShapeTest {
*/ */
@Test @Test
public void constructor_nmk_noName() { public void constructor_nmk_noName() {
try { try {
new Shape(null, 5, 72, 17); new Shape(null, 5, 72, 17);
fail("Should throw NullPointerException"); fail("Should throw NullPointerException");
@ -293,7 +289,6 @@ public class ShapeTest {
*/ */
@Test @Test
public void constructor_np_noName() { public void constructor_np_noName() {
try { try {
new Shape(null, 5, 0.1); new Shape(null, 5, 0.1);
fail("Should throw NullPointerException"); fail("Should throw NullPointerException");
@ -307,7 +302,6 @@ public class ShapeTest {
*/ */
@Test @Test
public void constructor_pmk_noName() { public void constructor_pmk_noName() {
try { try {
new Shape(null, 0.1, 72, 17); new Shape(null, 0.1, 72, 17);
fail("Should throw NullPointerException"); fail("Should throw NullPointerException");

View File

@ -31,7 +31,7 @@ import java.util.PrimitiveIterator.OfInt;
import org.junit.Test; import org.junit.Test;
/** /**
* Tests the static hasher. * Tests the {@link StaticHasher}.
*/ */
public class StaticHasherTest { public class StaticHasherTest {

View File

@ -27,7 +27,6 @@ import org.junit.Test;
/** /**
* Tests the MD5 cyclic hash function. * Tests the MD5 cyclic hash function.
*
*/ */
public class MD5CyclicTest { public class MD5CyclicTest {

View File

@ -27,7 +27,6 @@ import org.junit.Test;
/** /**
* Test that the Murmur3 128 x86 hash function works correctly. * Test that the Murmur3 128 x86 hash function works correctly.
*
*/ */
public class Murmur128x86CyclicTest { public class Murmur128x86CyclicTest {

View File

@ -27,7 +27,6 @@ import org.junit.Test;
/** /**
* Test that the Murmur3 32 x86 hash function works correctly. * Test that the Murmur3 32 x86 hash function works correctly.
*
*/ */
public class Murmur32x86IterativeTest { public class Murmur32x86IterativeTest {

View File

@ -26,8 +26,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.function.ObjectsHashIt
import org.junit.Test; import org.junit.Test;
/** /**
* Tests that the Objects hash works correctly.. * Tests that the Objects hash works correctly.
*
*/ */
public class ObjectsHashIterativeTest { public class ObjectsHashIterativeTest {