From 15a41ec38eaf5baca7c4266de52d1ae86ee9488b Mon Sep 17 00:00:00 2001
From: Jannis Harder <harder@informatik.uni-luebeck.de>
Date: Mon, 2 May 2011 02:28:19 +0200
Subject: Documented the Event/Listener classes

git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@60 72836036-5685-4462-b002-a69064685172
---
 src/jrummikub/util/IEvent1.java | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

(limited to 'src/jrummikub/util/IEvent1.java')

diff --git a/src/jrummikub/util/IEvent1.java b/src/jrummikub/util/IEvent1.java
index 4108078..52b9bf4 100644
--- a/src/jrummikub/util/IEvent1.java
+++ b/src/jrummikub/util/IEvent1.java
@@ -1,7 +1,25 @@
 package jrummikub.util;
 
+/**
+ * Interface for classes that can generate events having a single parameter
+ * 
+ * @param <T>
+ *            type of the event parameter
+ */
 public interface IEvent1<T> {
-  public void add(IListener1<T> listener);
+	/**
+	 * Start to publish all events to a given listener
+	 * 
+	 * @param listener
+	 *            target listener
+	 */
+	public void add(IListener1<T> listener);
 
-  public void remove(IListener1<T> listener);
+	/**
+	 * Stop publishing events to a given listener
+	 * 
+	 * @param listener
+	 *            target listener
+	 */
+	public void remove(IListener1<T> listener);
 }
-- 
cgit v1.2.3