Update comments to the CombinationGenerator.

dpaukov · Feb 20, 2024 · 0180037 · 0180037
1 parent 13d6bdb
commit 0180037
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/main/java/org/paukov/combinatorics3/CombinationGenerator.java b/src/main/java/org/paukov/combinatorics3/CombinationGenerator.java
@@ -21,13 +21,17 @@ public class CombinationGenerator<T> {
 
   /**
    * Creates a generator to produce combinations of the given length of elements.
+   * @param length The length of the generated combinations.
+   * @return The requested generator.
    */
   public IGenerator<List<T>> simple(int length) {
     return new SimpleCombinationGenerator<>(originalVector, length);
   }
 
   /**
    * Creates a generator to produce combinations with repetitions of the given length of elements.
+   * @param length The length of the generated combinations.
+   * @return The requested generator.
    */
   public IGenerator<List<T>> multi(int length) {
     return new MultiCombinationGenerator<>(originalVector, length);