Bugfix: Events with sigantures resolve parameter describtions incorrectly, see #136

Author: sebastian-lenz

bin/typedoc.js

@@ -4161,7 +4161,7 @@ var td;
                 var rawComment = CommentPlugin.getComment(node);
                 if (!rawComment)
                     return;
-                if (reflection.kindOf(td.models.ReflectionKind.FunctionOrMethod)) {
+                if (reflection.kindOf(td.models.ReflectionKind.FunctionOrMethod) || (reflection.kindOf(td.models.ReflectionKind.Event) && reflection['signatures'])) {
                     var comment = CommentPlugin.parseComment(rawComment, reflection.comment);
                     this.applyModifiers(reflection, comment);
                 }

src/td/converter/plugins/CommentPlugin.ts

@@ -158,7 +158,7 @@ module td.converter
             var rawComment = CommentPlugin.getComment(node);
             if (!rawComment) return;
 
-            if (reflection.kindOf(models.ReflectionKind.FunctionOrMethod)) {
+            if (reflection.kindOf(models.ReflectionKind.FunctionOrMethod) || (reflection.kindOf(models.ReflectionKind.Event) && reflection['signatures'])) {
                 var comment = CommentPlugin.parseComment(rawComment, reflection.comment);
                 this.applyModifiers(reflection, comment);
             } else if (reflection.kindOf(models.ReflectionKind.Module)) {

test/converter/events-overloads/events-overloads.ts

@@ -0,0 +1,45 @@
+/// <reference path="../lib.core.d.ts" />
+
+/**
+ * Encapsulates some information for background http transfers.
+ *
+ * @see https://github.com/sebastian-lenz/typedoc/issues/136
+ */
+interface Test
+{
+    /**
+     * Subscribe for a general event by name.
+     *
+     * @event
+     * @param event The name of the event to subscribe for.
+     * @param handler The handler called when the event occure.
+     */
+    on(event: string, handler: (e:any) => void): void;
+
+    /**
+     * Subscribe for error notifications.
+     *
+     * @event
+     * @param event The name of the event to subscribe for.
+     * @param handler A handler that will receive the error details
+     */
+    on(event: "error", handler: (e:any) => void): void;
+
+    /**
+     * Subscribe for progress notifications.
+     *
+     * @event
+     * @param event The name of the event to subscribe for.
+     * @param handler A handler that will receive a progress event with the current and expected total bytes
+     */
+    on(event: "progress", handler: (e:any) => void): void;
+
+    /**
+     * Subscribe for success notification.
+     *
+     * @event
+     * @param event The name of the event to subscribe for.
+     * @param handler A function that will be called with general event data upon successful completion
+     */
+    on(event: "complete", handler: (e:any) => void): void;
+}