big documentation update - all public functions and classes are documented now

src/Util/NamedEventHandler.js

@@ -1,8 +1,19 @@
+
+/**
+ * Handles named events.
+ */
 export default class NamedEventHandler {
   constructor () {
     this._eventListener = new Map()
     this._stateListener = new Map()
   }
+
+  /**
+   * @private
+   * Returns all listeners that listen to a specified name.
+   *
+   * @param {String} name The query event name.
+   */
   _getListener (name) {
     let listeners = this._eventListener.get(name)
     if (listeners === undefined) {
@@ -14,14 +25,34 @@ export default class NamedEventHandler {
     }
     return listeners
   }
+
+  /**
+   * Adds a named event listener. The listener is removed after it has been
+   * called once.
+   *
+   * @param {String} name The event name to listen to.
+   * @param {Function} f The function that is executed when the event is fired.
+   */
   once (name, f) {
     let listeners = this._getListener(name)
     listeners.once.add(f)
   }
+
+  /**
+   * Adds a named event listener.
+   *
+   * @param {String} name The event name to listen to.
+   * @param {Function} f The function that is executed when the event is fired.
+   */
   on (name, f) {
     let listeners = this._getListener(name)
     listeners.on.add(f)
   }
+
+  /**
+   * @private
+   * Init the saved state for an event name.
+   */
   _initStateListener (name) {
     let state = this._stateListener.get(name)
     if (state === undefined) {
@@ -33,9 +64,20 @@ export default class NamedEventHandler {
     }
     return state
   }
+
+  /**
+   * Returns a Promise that is resolved when the event name is called.
+   * The Promise is immediately resolved when the event name was called in the
+   * past.
+   */
   when (name) {
     return this._initStateListener(name).promise
   }
+
+  /**
+   * Remove an event listener that was registered with either
+   * {@link EventHandler#on} or {@link EventHandler#once}.
+   */
   off (name, f) {
     if (name == null || f == null) {
       throw new Error('You must specify event name and function!')
@@ -46,6 +88,14 @@ export default class NamedEventHandler {
       listener.once.delete(f)
     }
   }
+
+  /**
+   * Emit a named event. All registered event listeners that listen to the
+   * specified name will receive the event.
+   *
+   * @param {String} name The event name.
+   * @param {Array} args The arguments that are applied to the event listener.
+   */
   emit (name, ...args) {
     this._initStateListener(name).resolve()
     const listener = this._eventListener.get(name)