Make registering event handlers easier

Author: J0B10

src/main/scala/org/codeoverflow/chatoverflow/requirement/impl/EventInputImpl.scala

@@ -20,10 +20,21 @@ abstract class EventInputImpl[T <: Event, C <: Connector](implicit ctc: ClassTag
 
   protected val handlers: ListBuffer[EventHandler[_ <: T]] = ListBuffer[EventHandler[_ <: T]]()
 
+  /**
+    * Register a new event handler that listens for a specific event
+    *
+    * @param eventHandler consumer for which `accept()` is called if the event is fired
+    * @param eventClass   class of the events for which this listener should listen
+    */
   override def registerEventHandler[S <: T](eventHandler: Consumer[S], eventClass: Class[S]): Unit = {
     handlers += EventHandler[S](eventHandler, eventClass)
   }
 
+  /**
+    * Use this methods to fire an event.
+    * All eventHandlers listening for that event will be triggered.
+    * @param event the event that should be fired
+    */
   protected def call[S <: T](event: S)(implicit cts: ClassTag[S]): Unit = {
     handlers.filter(handler => handler.clazz == cts.runtimeClass)
       .foreach(handler => handler.consumer.asInstanceOf[Consumer[S]].accept(event))