Documented the Event/Listener classes

git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@60 72836036-5685-4462-b002-a69064685172

1 files changed, 18 insertions, 1 deletions

diff --git a/src/jrummikub/util/IListener2.java b/src/jrummikub/util/IListener2.java
index b1832c1..1733208 100644
--- a/src/jrummikub/util/IListener2.java
+++ b/src/jrummikub/util/IListener2.java
@@ -1,5 +1,22 @@
 package jrummikub.util;
 
+/**
+ * Interface for classes that can receive parameterless events having a two
+ * parameters
+ * 
+ * @param <T1>
+ *            type of the first event parameter
+ * @param <T2>
+ *            type of the first event parameter
+ */
 public interface IListener2<T1, T2> {
-  public void fire(T1 value1, T2 value2);
+	/**
+	 * This method is called whenever a class we're listening to emits an event
+	 * 
+	 * @param value1
+	 *            the first event parameter
+	 * @param value2
+	 *            the second event parameter
+	 */
+	public void fire(T1 value1, T2 value2);
 }