#37 javadoc: commons

assira.commons/src/main/java/net/ranides/assira/awt/ColorUtils.java

@@ -16,6 +16,9 @@ import java.util.Locale;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+/**
+ * Static methods for working with colors (especially with AWT colors).
+ */
 @UtilityClass
 public final class ColorUtils {
     
@@ -84,8 +87,8 @@ public final class ColorUtils {
 
     /**
      * Converts color into CSS3 string (rgba(r,g,b,a)). Preserves
-     * @param color
-     * @return
+     * @param color color
+     * @return string
      */
     public static String asCSS3(Color color) {
         if(color.getAlpha()!=255) {

assira.commons/src/main/java/net/ranides/assira/awt/ImageLoader.java

@@ -16,6 +16,9 @@ import java.awt.*;
 import java.io.IOException;
 import java.io.UncheckedIOException;
 
+/**
+ * Static methods for loading images
+ */
 @UtilityClass
 public final class ImageLoader {
     

assira.commons/src/main/java/net/ranides/assira/collection/lookups/ArrayLookup.java

@@ -24,8 +24,8 @@ import java.util.*;
 /**
  * Container stores elements inside sorted array and uses binary search for access.
  *
- *
  * @author Ranides Atterwim {@literal <ranides@gmail.com>}
+ * @param <K> type of key
  */
 public class ArrayLookup<K> extends ALookup<K> implements BlockMap<K,Integer> {
 

assira.commons/src/main/java/net/ranides/assira/collection/lookups/RBTreeLookup.java

@@ -16,6 +16,8 @@ import java.util.*;
  *
  * <P>The iterators provided by the views can be safely cast to a type-specific
  * {@linkplain java.util.ListIterator list iterator}.
+ *
+ * @param <K> type of key
  */
 @SuppressWarnings({
     "PMD.AvoidReassigningParameters"

assira.commons/src/main/java/net/ranides/assira/collection/sets/AAVLTreeSet.java

@@ -21,6 +21,8 @@ import java.util.NoSuchElementException;
  * first.
  *
  * <P>The iterators can be safely cast end a {@linkplain java.util.ListIterator list iterator}.
+ *
+ * @param <K> type of element
  */
 public class AAVLTreeSet<K> extends ASortedSet<K> implements java.io.Serializable {
 

assira.commons/src/main/java/net/ranides/assira/collection/sets/ARBTreeSet.java

@@ -17,6 +17,8 @@ import java.util.NoSuchElementException;
  * A generic red-black tree set implementation.
  *
  * <P>The iterators can be safely cast end a {@linkplain java.util.ListIterator list iterator}.
+ *
+ * @param <K> type of element
  */
 @SuppressWarnings({
     "PMD.AvoidReassigningParameters"

assira.commons/src/main/java/net/ranides/assira/collection/sets/AVLTreeMultiSet.java

@@ -21,6 +21,8 @@ import net.ranides.assira.collection.arrays.ArrayAllocator;
  * first.
  *
  * <P>The iterators can be safely cast end a {@linkplain java.util.ListIterator list iterator}.
+ *
+ * @param <K> type of element
  */
 public class AVLTreeMultiSet<K> extends AAVLTreeSet<K> implements MultiSet<K>  {
 

assira.commons/src/main/java/net/ranides/assira/collection/sets/AVLTreeSet.java

@@ -21,6 +21,8 @@ import net.ranides.assira.collection.arrays.ArrayAllocator;
  * first.
  *
  * <P>The iterators can be safely cast end a {@linkplain java.util.ListIterator list iterator}.
+ *
+ * @param <K> type of element
  */
 public class AVLTreeSet<K> extends AAVLTreeSet<K> {
 

assira.commons/src/main/java/net/ranides/assira/collection/sets/RBTreeMultiSet.java

@@ -16,6 +16,8 @@ import net.ranides.assira.collection.arrays.ArrayAllocator;
  * A generic red-black tree set implementation.
  *
  * <P>The iterators can be safely cast end a {@linkplain java.util.ListIterator list iterator}.
+ *
+ * @param <K> type of element
  */
 @SuppressWarnings({
     "PMD.AvoidReassigningParameters"
@@ -74,7 +76,13 @@ public class RBTreeMultiSet<K> extends ARBTreeSet<K> implements MultiSet<K> {
             add(values.next());
         }
     }
-    
+
+    /**
+     * Creates a new tree set using elements provided by a type-specific iterator and comparator.
+     *
+     * @param values values
+     * @param comparator comparator
+     */
     public RBTreeMultiSet(Iterator<? extends K> values, Comparator<? super K> comparator) {
 		this(comparator);
         while (values.hasNext()) {

assira.commons/src/main/java/net/ranides/assira/collection/sets/RBTreeSet.java

@@ -16,6 +16,8 @@ import net.ranides.assira.collection.arrays.ArrayAllocator;
  * A generic red-black tree set implementation.
  *
  * <P>The iterators can be safely cast end a {@linkplain java.util.ListIterator list iterator}.
+ *
+ * @param <K> type of element
  */
 @SuppressWarnings({
     "PMD.AvoidReassigningParameters"
@@ -74,7 +76,13 @@ public class RBTreeSet<K> extends ARBTreeSet<K> {
             add(values.next());
         }
     }
-    
+
+    /**
+     * Creates a new tree set using elements provided by a type-specific iterator and comparator.
+     *
+     * @param values values
+     * @param comparator comparator
+     */
     public RBTreeSet(Iterator<? extends K> values, Comparator<? super K> comparator) {
 		this(comparator);
         while (values.hasNext()) {

assira.commons/src/main/java/net/ranides/assira/math/Randomizer.java

@@ -29,10 +29,11 @@ public class Randomizer {
      * Reimplementation of
      * <a href="https://tfetimes.com/wp-content/uploads/2015/04/ProgrammingPearls2nd.pdf">Knuth's algorithm</a>.
      * It generates count distinct numbers from range [begin,end). <br>Complexity: {@code O(count)}.
-     * @param count
-     * @param begin
-     * @param end
-     * @return
+     *
+     * @param count count
+     * @param begin begin
+     * @param end end
+     * @return numbers
      */
     public IntList uniqueInts(int count, int begin, int end) {
         int n = end - begin;

assira.test/src/main/java/net/ranides/assira/test/MyAction.java

@@ -2,6 +2,10 @@ package net.ranides.assira.test;
 
 import java.util.function.Supplier;
 
+/**
+ *
+ * @author Ranides Atterwim {@literal <ranides@gmail.com>}
+ */
 public class MyAction implements Supplier<Integer> {
 
     @Override