update docs

chrissilb · Oct 6, 2023 · 0f9089e · 0f9089e
1 parent a440e4b
commit 0f9089e
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/main/java/de/gwasch/code/escframework/states/functions/Function.java b/src/main/java/de/gwasch/code/escframework/states/functions/Function.java
@@ -1,5 +1,11 @@
 package de.gwasch.code.escframework.states.functions;
 
+/**
+ * A {@code Function} can be injected to a {@link FunctionState}. It provides a {@code State} value according to its
+ * function algorithm. Those implementations typically use {@code State} parameters.
+ *   
+ * @param <T> the type of the {@code State} value
+ */
 public interface Function<T> {
 
 	T getValue();