More documentation

StronglyTypesEvents-0.2.0.ts

@@ -90,7 +90,6 @@ class SimpleEventDispatcher<TArgs> extends DispatcherBase<ISimpleEventHandler<TA
 {
     /**
      * Dispatches the event.
-     * @param sender The sender.
      * @param args The arguments object.
      */
     dispatch(args: TArgs): void {
@@ -101,7 +100,6 @@ class SimpleEventDispatcher<TArgs> extends DispatcherBase<ISimpleEventHandler<TA
 
     /**
      * Dispatches the events thread.
-     * @param sender The sender.
      * @param args The arguments object.
      */
     dispatchAsync(args: TArgs): void {

typings/StronglyTypesEvents-0.2.0.d.ts

@@ -11,13 +11,20 @@
  * Event handler function with a generic sender and a generic argument.
  */
 interface IEventHandler<TSender, TArgs> {
+    /**
+      * @sender The sender.
+      * @args The argument.
+      */
     (sender: TSender, args: TArgs): void
 }
 
 /** 
  * Event handler function with a generic argument
  */
 interface ISimpleEventHandler<TArgs> {
+    /**
+      * @args The argument.
+      */
     (args: TArgs): void
 }
 
@@ -26,8 +33,14 @@ interface ISimpleEventHandler<TArgs> {
   */
 interface ISubscribable<THandlerType> {
 
+    /** Subscribe to the event.
+      * @param fn The event handler that is called when the event is dispatched.
+      */
     subscribe(fn: THandlerType): void;
 
+    /** Unsubscribe from the event.
+      * @param fn The event handler that is will be unsubsribed from the event.
+      */
     unsubscribe(fn: THandlerType): void;
 }
 
@@ -48,8 +61,16 @@ interface ISimpleEvent<TArgs> extends ISubscribable<ISimpleEventHandler<TArgs>>
  */
 interface IBaseEventHandling<TEventHandler> {
 
+    /** Subscribe to the event with the specified name.
+      * @param name The name of the event.
+      * @param fn The event handler that is called when the event is dispatched.
+      */
     subscribe(name: string, fn: TEventHandler): void;
-
+
+    /** Unsubscribe from the event with the specified name.
+      * @param name The name of the event.
+      * @param fn The event handler that is will be unsubsribed from the event.
+      */
     unsubscribe(name: string, fn: TEventHandler): void;
 }