Skip to content

Commit 5ff4ff8

Browse files
committed
fix javadocs
Signed-off-by: Sebastian Hoß <[email protected]>
1 parent 17e43e2 commit 5ff4ff8

File tree

4 files changed

+13
-3
lines changed

4 files changed

+13
-3
lines changed

memoization-shared/src/main/java/de/xn__ho_hia/memoization/shared/MemoizationDefaults.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ public static Supplier<String> defaultKeySupplier() {
2727
}
2828

2929
/**
30+
* @param <T>
31+
* the type of the first argument to the function
32+
* @param <U>
33+
* the type of the second argument to the function
3034
* @return The default key function used throughout the library.
3135
*/
3236
public static <T, U> BiFunction<T, U, String> hashCodeKeyFunction() {
@@ -38,6 +42,8 @@ public static <T, U> BiFunction<T, U, String> hashCodeKeyFunction() {
3842
}
3943

4044
/**
45+
* @param <VALUE>
46+
* the type of the first argument to the function
4147
* @return The default key function for {@link java.util.function.ObjDoubleConsumer}.
4248
*/
4349
public static <VALUE> ObjDoubleFunction<VALUE, String> objDoubleConsumerHashCodeKeyFunction() {
@@ -49,6 +55,8 @@ public static <VALUE> ObjDoubleFunction<VALUE, String> objDoubleConsumerHashCode
4955
}
5056

5157
/**
58+
* @param <VALUE>
59+
* the type of the first argument to the function
5260
* @return The default key function for {@link java.util.function.ObjIntConsumer}.
5361
*/
5462
public static <VALUE> ObjIntFunction<VALUE, String> objIntConsumerHashCodeKeyFunction() {
@@ -60,6 +68,8 @@ public static <VALUE> ObjIntFunction<VALUE, String> objIntConsumerHashCodeKeyFun
6068
}
6169

6270
/**
71+
* @param <VALUE>
72+
* the type of the first argument to the function
6373
* @return The default key function for {@link java.util.function.ObjLongConsumer}.
6474
*/
6575
public static <VALUE> ObjLongFunction<VALUE, String> objLongConsumerHashCodeKeyFunction() {

memoization-shared/src/main/java/de/xn__ho_hia/memoization/shared/ObjDoubleFunction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public interface ObjDoubleFunction<VALUE, RESULT> {
2020
* The value to apply.
2121
* @param d
2222
* The double value to apply.
23-
* @return The result of applying the given value & double.
23+
* @return The result of applying the given value and double.
2424
*/
2525
RESULT apply(VALUE value, double d);
2626

memoization-shared/src/main/java/de/xn__ho_hia/memoization/shared/ObjIntFunction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public interface ObjIntFunction<VALUE, RESULT> {
2020
* The value to apply.
2121
* @param i
2222
* The integer value to apply.
23-
* @return The result of applying the given value & integer.
23+
* @return The result of applying the given value and integer.
2424
*/
2525
RESULT apply(VALUE value, int i);
2626

memoization-shared/src/main/java/de/xn__ho_hia/memoization/shared/ObjLongFunction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public interface ObjLongFunction<VALUE, RESULT> {
2020
* The value to apply.
2121
* @param i
2222
* The long value to apply.
23-
* @return The result of applying the given value & long.
23+
* @return The result of applying the given value and long.
2424
*/
2525
RESULT apply(VALUE value, long i);
2626

0 commit comments

Comments
 (0)