commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aherb...@apache.org
Subject [commons-collections] 11/12: Correct test javadoc headers.
Date Mon, 17 Feb 2020 14:10:41 GMT
This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git

commit 7aaf396c836e4aca4f252053c9540214da376a60
Author: aherbert <a.herbert@sussex.ac.uk>
AuthorDate: Mon Feb 17 13:44:14 2020 +0000

    Correct test javadoc headers.
---
 .../commons/collections4/bloomfilter/AbstractBloomFilterTest.java | 3 +--
 .../commons/collections4/bloomfilter/BitSetBloomFilterTest.java   | 3 +--
 .../commons/collections4/bloomfilter/CountingBloomFilterTest.java | 3 +--
 .../collections4/bloomfilter/DefaultBloomFilterMethodsTest.java   | 3 +--
 .../commons/collections4/bloomfilter/HasherBloomFilterTest.java   | 3 +--
 .../commons/collections4/bloomfilter/SetOperationsTest.java       | 3 +--
 .../collections4/bloomfilter/hasher/CommonComparatorTest.java     | 3 +--
 .../collections4/bloomfilter/hasher/DeepComparatorTest.java       | 3 +--
 .../collections4/bloomfilter/hasher/DynamicHasherBuilderTest.java | 3 +--
 .../collections4/bloomfilter/hasher/DynamicHasherTest.java        | 3 +--
 .../bloomfilter/hasher/HashFunctionIdentityImplTest.java          | 3 +--
 .../apache/commons/collections4/bloomfilter/hasher/ShapeTest.java | 8 +-------
 .../commons/collections4/bloomfilter/hasher/StaticHasherTest.java | 2 +-
 .../collections4/bloomfilter/hasher/function/MD5CyclicTest.java   | 1 -
 .../bloomfilter/hasher/function/Murmur128x86CyclicTest.java       | 1 -
 .../bloomfilter/hasher/function/Murmur32x86IterativeTest.java     | 1 -
 .../bloomfilter/hasher/function/ObjectsHashIterativeTest.java     | 3 +--
 17 files changed, 14 insertions(+), 35 deletions(-)

diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractBloomFilterTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractBloomFilterTest.java
index a338899..0230c30 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractBloomFilterTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractBloomFilterTest.java
@@ -33,8 +33,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.StaticHasher;
 import org.junit.Test;
 
 /**
- * Test standard methods.
- *
+ * Test standard methods in the {@link BloomFilter} interface.
  */
 public abstract class AbstractBloomFilterTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/BitSetBloomFilterTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/BitSetBloomFilterTest.java
index 9fc4995..e7edf0f 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/BitSetBloomFilterTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/BitSetBloomFilterTest.java
@@ -27,8 +27,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.StaticHasher;
 import org.junit.Test;
 
 /**
- * Tests for the BitSetBloomFilter implementation.
- *
+ * Tests for the {@link BitSetBloomFilter}.
  */
 public class BitSetBloomFilterTest extends AbstractBloomFilterTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilterTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilterTest.java
index f6e95dc..55661dc 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilterTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilterTest.java
@@ -32,8 +32,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.StaticHasher;
 import org.junit.Test;
 
 /**
- * Tests for the Counting Bloom filter implementation.
- *
+ * Tests for the {@link CountingBloomFilter}.
  */
 public class CountingBloomFilterTest extends AbstractBloomFilterTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/DefaultBloomFilterMethodsTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/DefaultBloomFilterMethodsTest.java
index c1f248d..bd4ce0f 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/DefaultBloomFilterMethodsTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/DefaultBloomFilterMethodsTest.java
@@ -25,8 +25,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.Shape;
 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 {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/HasherBloomFilterTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/HasherBloomFilterTest.java
index 1cba7b6..50cd58d 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/HasherBloomFilterTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/HasherBloomFilterTest.java
@@ -26,8 +26,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.function.MD5Cyclic;
 import org.junit.Test;
 
 /**
- * Tests the HasherBloomFilter implementation.
- *
+ * Tests the {@link HasherBloomFilter}.
  */
 public class HasherBloomFilterTest extends AbstractBloomFilterTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/SetOperationsTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/SetOperationsTest.java
index 233ec42..d492800 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/SetOperationsTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/SetOperationsTest.java
@@ -27,8 +27,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.StaticHasher;
 import org.junit.Test;
 
 /**
- * Test SetOperations implementation
- *
+ * Test {@link SetOperations}.
  */
 public class SetOperationsTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/CommonComparatorTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/CommonComparatorTest.java
index 0ab7e70..da0f1f6 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/CommonComparatorTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/CommonComparatorTest.java
@@ -30,8 +30,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.HashFunctionIdentity.S
 import org.junit.Test;
 
 /**
- * Tests of the HashFunctionIdentity.COMMON_COMPARATOR
- *
+ * Tests of the {@link HashFunctionIdentity#COMMON_COMPARATOR}.
  */
 public class CommonComparatorTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/DeepComparatorTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/DeepComparatorTest.java
index 934dacf..c4f8d46 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/DeepComparatorTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/DeepComparatorTest.java
@@ -30,8 +30,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.HashFunctionIdentity.S
 import org.junit.Test;
 
 /**
- * Tests of the HashFunctionIdentity.DEEP_COMPARATOR
- *
+ * Tests of the {@link HashFunctionIdentity#DEEP_COMPARATOR}.
  */
 public class DeepComparatorTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/DynamicHasherBuilderTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/DynamicHasherBuilderTest.java
index 33b044c..b271cd9 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/DynamicHasherBuilderTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/DynamicHasherBuilderTest.java
@@ -28,8 +28,7 @@ import org.junit.Before;
 import org.junit.Test;
 
 /**
- * DynamicHasher Builder tests.
- *
+ * {@link DynamicHasher.Builder} tests.
  */
 public class DynamicHasherBuilderTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/DynamicHasherTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/DynamicHasherTest.java
index 0c77970..3babbb7 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/DynamicHasherTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/DynamicHasherTest.java
@@ -29,8 +29,7 @@ import org.junit.Before;
 import org.junit.Test;
 
 /**
- * Tests the Dynamic Hasher
- *
+ * Tests the {@link DynamicHasher}.
  */
 public class DynamicHasherTest {
     private DynamicHasher.Builder builder;
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/HashFunctionIdentityImplTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/HashFunctionIdentityImplTest.java
index 01f68e0..ab37616 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/HashFunctionIdentityImplTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/HashFunctionIdentityImplTest.java
@@ -24,8 +24,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.HashFunctionIdentity.P
 import org.junit.Test;
 
 /**
- * Tests the HashFunctionIdentity implementation.
- *
+ * Tests the HashFunctionIdentity implementation ({@link HashFunctionIdentityImpl})..
  */
 public class HashFunctionIdentityImplTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/ShapeTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/ShapeTest.java
index 899cb65..78ba037 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/ShapeTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/ShapeTest.java
@@ -28,8 +28,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.Shape;
 import org.junit.Test;
 
 /**
- * Tests that the Shap class.
- *
+ * Tests the {@link Shape} class.
  */
 public class ShapeTest {
 
@@ -225,7 +224,6 @@ public class ShapeTest {
         } catch (final IllegalArgumentException expected) {
             // do nothing.
         }
-
         try {
             new Shape(testFunction, 10, 1.0);
             fail("Should have thrown IllegalArgumentException");
@@ -265,7 +263,6 @@ public class ShapeTest {
      */
     @Test
     public void constructor_nm_noName() {
-
         try {
             new Shape(null, 5, 72);
             fail("Should throw NullPointerException");
@@ -279,7 +276,6 @@ public class ShapeTest {
      */
     @Test
     public void constructor_nmk_noName() {
-
         try {
             new Shape(null, 5, 72, 17);
             fail("Should throw NullPointerException");
@@ -293,7 +289,6 @@ public class ShapeTest {
      */
     @Test
     public void constructor_np_noName() {
-
         try {
             new Shape(null, 5, 0.1);
             fail("Should throw NullPointerException");
@@ -307,7 +302,6 @@ public class ShapeTest {
      */
     @Test
     public void constructor_pmk_noName() {
-
         try {
             new Shape(null, 0.1, 72, 17);
             fail("Should throw NullPointerException");
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/StaticHasherTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/StaticHasherTest.java
index 30daaa9..dc9ce4f 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/StaticHasherTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/StaticHasherTest.java
@@ -31,7 +31,7 @@ import java.util.PrimitiveIterator.OfInt;
 import org.junit.Test;
 
 /**
- * Tests the static hasher.
+ * Tests the {@link StaticHasher}.
  */
 public class StaticHasherTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/MD5CyclicTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/MD5CyclicTest.java
index 428c02a..d82ea8a 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/MD5CyclicTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/MD5CyclicTest.java
@@ -27,7 +27,6 @@ import org.junit.Test;
 
 /**
  * Tests the MD5 cyclic hash function.
- *
  */
 public class MD5CyclicTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/Murmur128x86CyclicTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/Murmur128x86CyclicTest.java
index 6dd9730..35fc1c7 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/Murmur128x86CyclicTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/Murmur128x86CyclicTest.java
@@ -27,7 +27,6 @@ import org.junit.Test;
 
 /**
  * Test that the Murmur3 128 x86 hash function works correctly.
- *
  */
 public class Murmur128x86CyclicTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/Murmur32x86IterativeTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/Murmur32x86IterativeTest.java
index 96ad132..efe6da2 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/Murmur32x86IterativeTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/Murmur32x86IterativeTest.java
@@ -27,7 +27,6 @@ import org.junit.Test;
 
 /**
  * Test that the Murmur3 32 x86 hash function works correctly.
- *
  */
 public class Murmur32x86IterativeTest {
 
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/ObjectsHashIterativeTest.java
b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/ObjectsHashIterativeTest.java
index 17ebb11..4df7f75 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/ObjectsHashIterativeTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/hasher/function/ObjectsHashIterativeTest.java
@@ -26,8 +26,7 @@ import org.apache.commons.collections4.bloomfilter.hasher.function.ObjectsHashIt
 import org.junit.Test;
 
 /**
- * Tests that the Objects hash works correctly..
- *
+ * Tests that the Objects hash works correctly.
  */
 public class ObjectsHashIterativeTest {
 


Mime
View raw message