From 489068049e3d9f2eb658cc47c2248e4588850eef Mon Sep 17 00:00:00 2001 From: Klemek Date: Sun, 20 Jan 2019 15:10:49 +0100 Subject: [PATCH] Updated javadoc --- src/main/java/fr/klemek/betterlists/BetterArrayList.java | 8 ++++++-- .../fr/klemek/betterlists/BetterCopyOnWriteArrayList.java | 8 ++++++-- src/main/java/fr/klemek/betterlists/BetterLinkedList.java | 8 ++++++-- src/main/java/fr/klemek/betterlists/BetterList.java | 2 ++ src/main/java/fr/klemek/betterlists/BetterStack.java | 4 ++-- src/main/java/fr/klemek/betterlists/BetterVector.java | 8 ++++++-- 6 files changed, 28 insertions(+), 10 deletions(-) diff --git a/src/main/java/fr/klemek/betterlists/BetterArrayList.java b/src/main/java/fr/klemek/betterlists/BetterArrayList.java index 36aec18..973c7c5 100644 --- a/src/main/java/fr/klemek/betterlists/BetterArrayList.java +++ b/src/main/java/fr/klemek/betterlists/BetterArrayList.java @@ -19,7 +19,9 @@ public class BetterArrayList extends ArrayList implements BetterList { * Constructs a list containing the elements of the specified collection, in the * order they are returned by the collection's iterator. * + * @param - the type of List * @param c - the collection whose elements are to be placed into this list + * @return the constructed list */ public static BetterArrayList fromList(Collection c) { return new BetterArrayList<>(c); @@ -28,7 +30,9 @@ public class BetterArrayList extends ArrayList implements BetterList { /** * Constructs a list containing the elements given in argument. * + * @param - the type of List * @param a - the elements to be placed into this list + * @return the constructed list */ public static BetterArrayList asList(T... a) { return new BetterArrayList<>(a); @@ -83,8 +87,8 @@ public class BetterArrayList extends ArrayList implements BetterList { * @param fromIndex - low endpoint (inclusive) of the subList * @param toIndex - high endpoint (exclusive) of the subList * @return a view of the specified range within this list - * @throws IndexOutOfBoundsException for an illegal endpoint index value (fromIndex < 0 || toIndex > - * size || fromIndex > toIndex) + * @throws IndexOutOfBoundsException for an illegal endpoint index value (fromIndex < 0 || toIndex > + * size || fromIndex > toIndex) * @see java.util.List */ @Override diff --git a/src/main/java/fr/klemek/betterlists/BetterCopyOnWriteArrayList.java b/src/main/java/fr/klemek/betterlists/BetterCopyOnWriteArrayList.java index fdb7e5d..1df4025 100644 --- a/src/main/java/fr/klemek/betterlists/BetterCopyOnWriteArrayList.java +++ b/src/main/java/fr/klemek/betterlists/BetterCopyOnWriteArrayList.java @@ -20,7 +20,9 @@ public class BetterCopyOnWriteArrayList extends CopyOnWriteArrayList imple * Constructs a list containing the elements of the specified collection, in the * order they are returned by the collection's iterator. * + * @param - the type of List * @param c - the collection whose elements are to be placed into this list + * @return the constructed list */ public static BetterCopyOnWriteArrayList fromList(Collection c) { return new BetterCopyOnWriteArrayList<>(c); @@ -29,7 +31,9 @@ public class BetterCopyOnWriteArrayList extends CopyOnWriteArrayList imple /** * Constructs a list containing the elements given in argument. * + * @param - the type of List * @param a - the elements to be placed into this list + * @return the constructed list */ public static BetterCopyOnWriteArrayList asList(T... a) { return new BetterCopyOnWriteArrayList<>(a); @@ -75,8 +79,8 @@ public class BetterCopyOnWriteArrayList extends CopyOnWriteArrayList imple * @param fromIndex - low endpoint (inclusive) of the subList * @param toIndex - high endpoint (exclusive) of the subList * @return a view of the specified range within this list - * @throws IndexOutOfBoundsException for an illegal endpoint index value (fromIndex < 0 || toIndex > - * size || fromIndex > toIndex) + * @throws IndexOutOfBoundsException for an illegal endpoint index value (fromIndex < 0 || toIndex > + * size || fromIndex > toIndex) * @see java.util.List */ @Override diff --git a/src/main/java/fr/klemek/betterlists/BetterLinkedList.java b/src/main/java/fr/klemek/betterlists/BetterLinkedList.java index 8a0e5cf..d53ff71 100644 --- a/src/main/java/fr/klemek/betterlists/BetterLinkedList.java +++ b/src/main/java/fr/klemek/betterlists/BetterLinkedList.java @@ -19,7 +19,9 @@ public class BetterLinkedList extends LinkedList implements BetterList * Constructs a list containing the elements of the specified collection, in the * order they are returned by the collection's iterator. * + * @param - the type of List * @param c - the collection whose elements are to be placed into this list + * @return the constructed list */ public static BetterLinkedList fromList(Collection c) { return new BetterLinkedList<>(c); @@ -28,7 +30,9 @@ public class BetterLinkedList extends LinkedList implements BetterList /** * Constructs a list containing the elements given in argument. * + * @param - the type of List * @param a - the elements to be placed into this list + * @return the constructed list */ public static BetterLinkedList asList(T... a) { return new BetterLinkedList<>(a); @@ -74,8 +78,8 @@ public class BetterLinkedList extends LinkedList implements BetterList * @param fromIndex - low endpoint (inclusive) of the subList * @param toIndex - high endpoint (exclusive) of the subList * @return a view of the specified range within this list - * @throws IndexOutOfBoundsException for an illegal endpoint index value (fromIndex < 0 || toIndex > - * size || fromIndex > toIndex) + * @throws IndexOutOfBoundsException for an illegal endpoint index value (fromIndex < || toIndex > + * size || fromIndex > toIndex) * @see java.util.List */ @Override diff --git a/src/main/java/fr/klemek/betterlists/BetterList.java b/src/main/java/fr/klemek/betterlists/BetterList.java index 70306bd..5975d46 100644 --- a/src/main/java/fr/klemek/betterlists/BetterList.java +++ b/src/main/java/fr/klemek/betterlists/BetterList.java @@ -247,6 +247,7 @@ public interface BetterList extends List { /** * Sorts the elements of a sequence in ascending order by using a specified comparer. * + * @param The type of the projected values lists * @param selector - A transform function to apply to each element. * @return a List whose elements are sorted according to a key. */ @@ -260,6 +261,7 @@ public interface BetterList extends List { /** * Sorts the elements of a sequence in descending order by using a specified comparer. * + * @param The type of the projected values lists * @param selector - A transform function to apply to each element. * @return a List whose elements are sorted according to a key. */ diff --git a/src/main/java/fr/klemek/betterlists/BetterStack.java b/src/main/java/fr/klemek/betterlists/BetterStack.java index 6cf2ade..196725d 100644 --- a/src/main/java/fr/klemek/betterlists/BetterStack.java +++ b/src/main/java/fr/klemek/betterlists/BetterStack.java @@ -34,8 +34,8 @@ public class BetterStack extends Stack implements BetterList { * @param fromIndex - low endpoint (inclusive) of the subList * @param toIndex - high endpoint (exclusive) of the subList * @return a view of the specified range within this list - * @throws IndexOutOfBoundsException for an illegal endpoint index value (fromIndex < 0 || toIndex > - * size || fromIndex > toIndex) + * @throws IndexOutOfBoundsException for an illegal endpoint index value (fromIndex < || toIndex > + * size || fromIndex > toIndex) * @see java.util.List */ @Override diff --git a/src/main/java/fr/klemek/betterlists/BetterVector.java b/src/main/java/fr/klemek/betterlists/BetterVector.java index 6027c81..766bb5c 100644 --- a/src/main/java/fr/klemek/betterlists/BetterVector.java +++ b/src/main/java/fr/klemek/betterlists/BetterVector.java @@ -19,7 +19,9 @@ public class BetterVector extends Vector implements BetterList { * Constructs a vector containing the elements of the specified collection, in * the order they are returned by the collection's iterator. * + * @param - the type of List * @param c - the collection whose elements are to be placed into this vector + * @return the constructed list */ public static BetterVector fromList(Collection c) { return new BetterVector<>(c); @@ -28,7 +30,9 @@ public class BetterVector extends Vector implements BetterList { /** * Constructs a vector containing the elements given in argument. * + * @param - the type of List * @param a - the elements to be placed into this vector + * @return the constructed list */ public static BetterVector asVector(T... a) { return new BetterVector<>(a); @@ -97,8 +101,8 @@ public class BetterVector extends Vector implements BetterList { * @param fromIndex - low endpoint (inclusive) of the subList * @param toIndex - high endpoint (exclusive) of the subList * @return a view of the specified range within this list - * @throws IndexOutOfBoundsException for an illegal endpoint index value (fromIndex < 0 || toIndex > - * size || fromIndex > toIndex) + * @throws IndexOutOfBoundsException for an illegal endpoint index value (fromIndex < || toIndex > + * size || fromIndex > toIndex) * @see java.util.List */ @Override