docs: document ActionOnKey

AlchemistSimulator · Sep 12, 2024 · e009be4 · e009be4
1 parent 343b995
commit e009be4
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/src/main/kotlin/it/unibo/alchemist/boundary/fxui/interaction/keyboard/ActionOnKey.kt b/src/main/kotlin/it/unibo/alchemist/boundary/fxui/interaction/keyboard/ActionOnKey.kt
@@ -13,10 +13,18 @@ import it.unibo.alchemist.boundary.fxui.interaction.TriggerAction
 import javafx.scene.input.KeyCode
 
 /**
- * The [TriggerAction] objects regarding key strokes.
+ * The [TriggerAction] objects regarding keystrokes,
+ * which can be either [ActionOnKey.PRESSED] or [ActionOnKey.RELEASED].
  */
 enum class ActionOnKey {
+    /**
+     * The key was pressed.
+     */
     PRESSED,
+
+    /**
+     * The key was released.
+     */
     RELEASED,
     ;