First batch of JavaDoc that is being done.

-Added: JavaDoc for Map Interfaces.
-Added: JavaDoc for Abstract Map/Collection/Set
-Added: Ignore JavaDoc for tests/builder code.
-Added: More JavaDoc for Arrays.
This commit is contained in:
2021-04-25 03:45:57 +02:00
parent 199f50eb32
commit 2ca14f4d4f
48 changed files with 569 additions and 7 deletions
@@ -10,6 +10,7 @@ import speiger.src.collections.ints.maps.interfaces.Int2IntMap;
import speiger.src.collections.ints.utils.IntStrategy;
import speiger.src.collections.tests.MapTests;
@SuppressWarnings("javadoc")
public abstract class BaseInt2IntMapTest
{
protected static final IntStrategy STRATEGY = new Strategy();
@@ -8,6 +8,7 @@ import org.junit.Test;
import speiger.src.collections.ints.maps.interfaces.Int2IntNavigableMap;
import speiger.src.collections.tests.NavigableSetTest;
@SuppressWarnings("javadoc")
public abstract class BaseInt2IntNavigableMapTest extends BaseInt2IntSortedMapTest
{
@Override
@@ -8,6 +8,7 @@ import org.junit.Test;
import speiger.src.collections.ints.maps.interfaces.Int2IntSortedMap;
import speiger.src.collections.tests.SortedMapTests;
@SuppressWarnings("javadoc")
public abstract class BaseInt2IntSortedMapTest extends BaseInt2IntMapTest
{
@Override
@@ -14,6 +14,7 @@ import speiger.src.collections.ints.utils.IntCollections.SynchronizedCollection;
import speiger.src.collections.ints.utils.IntCollections.UnmodifiableCollection;
import speiger.src.collections.tests.CollectionTest;
@SuppressWarnings("javadoc")
public abstract class BaseIntCollectionTest extends BaseIntIterableTest
{
protected static final int[] ADD_ARRAY = new int[]{3212, -12, 423, -182, -4912};
@@ -10,6 +10,7 @@ import speiger.src.collections.ints.collections.IntIterable;
import speiger.src.collections.ints.collections.IntIterator;
import speiger.src.collections.tests.IterableTest;
@SuppressWarnings("javadoc")
public abstract class BaseIntIterableTest
{
protected static final int[] EMPTY_ARRAY = new int[0];
@@ -12,6 +12,7 @@ import speiger.src.collections.ints.lists.IntListIterator;
import speiger.src.collections.ints.utils.IntCollections;
import speiger.src.collections.tests.ListTest;
@SuppressWarnings("javadoc")
public abstract class BaseIntListTest extends BaseIntCollectionTest
{
@Override
@@ -8,6 +8,7 @@ import org.junit.Test;
import speiger.src.collections.ints.sets.IntNavigableSet;
import speiger.src.collections.tests.NavigableSetTest;
@SuppressWarnings("javadoc")
public abstract class BaseIntNavigableSetTest extends BaseIntSortedSetTest
{
@Override
@@ -11,6 +11,7 @@ import speiger.src.collections.ints.utils.IntArrays;
import speiger.src.collections.tests.IterableTest;
import speiger.src.collections.tests.PriorityQueueTest;
@SuppressWarnings("javadoc")
public abstract class BaseIntPriorityQueueTest extends BaseIntIterableTest
{
@Override
@@ -8,6 +8,7 @@ import org.junit.Test;
import speiger.src.collections.ints.sets.IntSortedSet;
import speiger.src.collections.tests.SortedSetTest;
@SuppressWarnings("javadoc")
public abstract class BaseIntSortedSetTest extends BaseIntCollectionTest
{
@Override
@@ -7,6 +7,7 @@ import org.junit.Test;
import speiger.src.collections.ints.utils.IIntArray;
@SuppressWarnings("javadoc")
public interface IIntArrayTest
{
static final int[] TEST_ARRAY = IntStream.range(0, 100).toArray();
@@ -7,6 +7,7 @@ import org.junit.Test;
import speiger.src.collections.ints.collections.IntStack;
@SuppressWarnings("javadoc")
public interface IIntStackTests
{
static final int[] TEST_ARRAY = IntStream.range(0, 100).toArray();
@@ -6,6 +6,7 @@ import speiger.src.collections.ints.base.BaseIntListTest;
import speiger.src.collections.ints.base.IIntArrayTest;
import speiger.src.collections.ints.base.IIntStackTests;
@SuppressWarnings("javadoc")
public class IntArrayListTest extends BaseIntListTest implements IIntStackTests, IIntArrayTest
{
@Override
@@ -7,6 +7,7 @@ import speiger.src.collections.ints.maps.impl.tree.Int2IntAVLTreeMap;
import speiger.src.collections.ints.maps.interfaces.Int2IntNavigableMap;
import speiger.src.collections.tests.SortedMapTests;
@SuppressWarnings("javadoc")
public class Int2IntAVLTreeMapTest extends BaseInt2IntNavigableMapTest
{
@Override
@@ -4,6 +4,7 @@ import speiger.src.collections.ints.base.BaseInt2IntSortedMapTest;
import speiger.src.collections.ints.maps.impl.misc.Int2IntArrayMap;
import speiger.src.collections.ints.maps.interfaces.Int2IntSortedMap;
@SuppressWarnings("javadoc")
public class Int2IntArrayMapTest extends BaseInt2IntSortedMapTest
{
@Override
@@ -4,6 +4,7 @@ import speiger.src.collections.ints.base.BaseInt2IntMapTest;
import speiger.src.collections.ints.maps.impl.customHash.Int2IntOpenCustomHashMap;
import speiger.src.collections.ints.maps.interfaces.Int2IntMap;
@SuppressWarnings("javadoc")
public class Int2IntCustomHashMapTest extends BaseInt2IntMapTest
{
@Override
@@ -4,6 +4,7 @@ import speiger.src.collections.ints.base.BaseInt2IntMapTest;
import speiger.src.collections.ints.maps.impl.hash.Int2IntOpenHashMap;
import speiger.src.collections.ints.maps.interfaces.Int2IntMap;
@SuppressWarnings("javadoc")
public class Int2IntHashMapTest extends BaseInt2IntMapTest
{
@@ -7,6 +7,7 @@ import speiger.src.collections.ints.maps.impl.customHash.Int2IntLinkedOpenCustom
import speiger.src.collections.ints.maps.interfaces.Int2IntSortedMap;
import speiger.src.collections.tests.SortedMapTests;
@SuppressWarnings("javadoc")
public class Int2IntLinkedOpenCustomHashMapTest extends BaseInt2IntSortedMapTest
{
@Override
@@ -7,6 +7,7 @@ import speiger.src.collections.ints.maps.impl.hash.Int2IntLinkedOpenHashMap;
import speiger.src.collections.ints.maps.interfaces.Int2IntSortedMap;
import speiger.src.collections.tests.SortedMapTests;
@SuppressWarnings("javadoc")
public class Int2IntLinkedOpenHashMapTest extends BaseInt2IntSortedMapTest
{
@Override
@@ -7,6 +7,7 @@ import speiger.src.collections.ints.maps.impl.tree.Int2IntRBTreeMap;
import speiger.src.collections.ints.maps.interfaces.Int2IntNavigableMap;
import speiger.src.collections.tests.SortedMapTests;
@SuppressWarnings("javadoc")
public class Int2IntRBTreeMapTest extends BaseInt2IntNavigableMapTest
{
@Override
@@ -2,6 +2,7 @@ package speiger.src.collections.ints.queues;
import speiger.src.collections.ints.base.BaseIntPriorityQueueTest;
@SuppressWarnings("javadoc")
public class IntArrayFIFOQueueTests extends BaseIntPriorityQueueTest
{
@Override
@@ -2,6 +2,7 @@ package speiger.src.collections.ints.queues;
import speiger.src.collections.ints.base.BaseIntPriorityQueueTest;
@SuppressWarnings("javadoc")
public class IntArrayPriorityQueueTests extends BaseIntPriorityQueueTest
{
@Override
@@ -2,6 +2,7 @@ package speiger.src.collections.ints.queues;
import speiger.src.collections.ints.base.BaseIntPriorityQueueTest;
@SuppressWarnings("javadoc")
public class IntHeapPriorityQueueTests extends BaseIntPriorityQueueTest
{
@Override
@@ -5,6 +5,7 @@ import java.util.EnumSet;
import speiger.src.collections.ints.base.BaseIntNavigableSetTest;
import speiger.src.collections.tests.SortedSetTest;
@SuppressWarnings("javadoc")
public class IntAVLTreeSetTests extends BaseIntNavigableSetTest
{
@Override
@@ -2,6 +2,7 @@ package speiger.src.collections.ints.sets;
import speiger.src.collections.ints.base.BaseIntSortedSetTest;
@SuppressWarnings("javadoc")
public class IntArraySetTests extends BaseIntSortedSetTest
{
@Override
@@ -8,6 +8,7 @@ import speiger.src.collections.ints.collections.IntCollection;
import speiger.src.collections.ints.utils.IntStrategy;
import speiger.src.collections.tests.SortedSetTest;
@SuppressWarnings("javadoc")
public class IntHashSetTests
{
public static abstract class BaseIntOpenHashSetTests extends BaseIntSortedSetTest
@@ -5,6 +5,7 @@ import java.util.EnumSet;
import speiger.src.collections.ints.base.BaseIntNavigableSetTest;
import speiger.src.collections.tests.SortedSetTest;
@SuppressWarnings("javadoc")
public class IntRBTreeSetTests extends BaseIntNavigableSetTest
{
@@ -6,6 +6,7 @@ import java.util.stream.IntStream;
import org.junit.Assert;
import org.junit.Test;
@SuppressWarnings("javadoc")
public class SortingTests
{
public static final int[] SMALL_TEST = IntStream.range(0, 5000).toArray();
@@ -1,5 +1,6 @@
package speiger.src.collections.tests;
@SuppressWarnings("javadoc")
public enum CollectionTest
{
ADD,
@@ -1,5 +1,6 @@
package speiger.src.collections.tests;
@SuppressWarnings("javadoc")
public enum IterableTest
{
FOR_EACH,
@@ -1,5 +1,6 @@
package speiger.src.collections.tests;
@SuppressWarnings("javadoc")
public enum ListTest
{
ADD_INDEX,
@@ -1,5 +1,6 @@
package speiger.src.collections.tests;
@SuppressWarnings("javadoc")
public enum MapTests
{
PUT,
@@ -1,5 +1,6 @@
package speiger.src.collections.tests;
@SuppressWarnings("javadoc")
public enum NavigableMapTests
{
DESENDING,
@@ -1,5 +1,6 @@
package speiger.src.collections.tests;
@SuppressWarnings("javadoc")
public enum NavigableSetTest
{
DESENDING,
@@ -1,5 +1,6 @@
package speiger.src.collections.tests;
@SuppressWarnings("javadoc")
public enum PriorityQueueTest
{
IN_OUT,
@@ -1,5 +1,6 @@
package speiger.src.collections.tests;
@SuppressWarnings("javadoc")
public enum SortedMapTests
{
PUT_MOVE,
@@ -1,5 +1,6 @@
package speiger.src.collections.tests;
@SuppressWarnings("javadoc")
public enum SortedSetTest
{
ADD_MOVE,