From 5e9785af77494629bec932822e8fc05769b9caf0 Mon Sep 17 00:00:00 2001 From: Daniel Kirschten Date: Sat, 22 Jun 2019 10:34:04 +0200 Subject: [PATCH] Improved comments of GUIComponent --- .../logic/ui/model/components/GUIComponent.java | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java index 13ec4a60..472798f1 100644 --- a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java +++ b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java @@ -81,6 +81,11 @@ public abstract class GUIComponent /** * Adds the given pin to this component and calls pinAddedListeners and redrawListeners. + * + * @throws IllegalArgumentException if the pin doesn't belong to this component + * @throws IllegalArgumentException if there already is a pin with the given name + * + * @author Daniel Kirschten */ protected void addPin(Pin pin) { @@ -97,7 +102,9 @@ public abstract class GUIComponent /** * Removes the given pin from this component and calls pinAddedListeners and redrawListeners. * - * @throws NullPointerException if there was no pin with this name. + * @throws NullPointerException if there was no pin with this name + * + * @author Daniel Kirschten */ protected void removePin(String name) { @@ -213,6 +220,8 @@ public abstract class GUIComponent /** * Called when this component is clicked. Absolute coordinates of the click are given. Returns true if this component consumed this * click. + * + * @author Daniel Kirschten */ @SuppressWarnings({ "static-method", "unused" }) // this method is inteded to be overridden public boolean clicked(double x, double y) -- 2.17.1