From e56611c3fc6a0f5d22804426186734953e1dcb9e Mon Sep 17 00:00:00 2001 From: Sollace Date: Tue, 15 May 2018 16:25:11 +0200 Subject: [PATCH] Docs! --- src/main/java/com/minelittlepony/gui/IActionable.java | 7 +++++++ src/main/java/com/minelittlepony/gui/IGUIAction.java | 9 +++++++++ 2 files changed, 16 insertions(+) diff --git a/src/main/java/com/minelittlepony/gui/IActionable.java b/src/main/java/com/minelittlepony/gui/IActionable.java index 2417ac40..3ad22158 100644 --- a/src/main/java/com/minelittlepony/gui/IActionable.java +++ b/src/main/java/com/minelittlepony/gui/IActionable.java @@ -1,5 +1,12 @@ package com.minelittlepony.gui; +/** + * An element that can perform an action. + */ +@FunctionalInterface public interface IActionable { + /** + * Does whatever. + */ void perform(); } diff --git a/src/main/java/com/minelittlepony/gui/IGUIAction.java b/src/main/java/com/minelittlepony/gui/IGUIAction.java index cd5e4364..48aa5efa 100644 --- a/src/main/java/com/minelittlepony/gui/IGUIAction.java +++ b/src/main/java/com/minelittlepony/gui/IGUIAction.java @@ -1,6 +1,15 @@ package com.minelittlepony.gui; +/** + * Response actions for UI events. + */ @FunctionalInterface public interface IGUIAction { + /** + * Performs this action now. + * + * @param value New Value of the field being changed + * @return Adjusted value the field must take on + */ T perform(T value); }