add comments for referenced parameters in function signatures, see Ty…

…peStrong#2147
Leo-Nicolle · Jan 20, 2023 · 90a3670 · 90a3670
1 parent 0340ef4
commit 90a3670
Showing 1 changed file with 19 additions and 3 deletions.
diff --git a/src/lib/converter/plugins/CommentPlugin.ts b/src/lib/converter/plugins/CommentPlugin.ts
@@ -386,9 +386,10 @@ export class CommentPlugin extends ConverterComponent {
                 );
 
                 if (tag) {
-                    parameter.comment = new Comment(
-                        Comment.cloneDisplayParts(tag.content)
-                    );
+                    if(!parameter.comment){
+                        parameter.comment = new Comment();
+                    }
+                    parameter.comment.summary = Comment.cloneDisplayParts(tag.content);
                 }
             });
 
@@ -542,6 +543,21 @@ function moveNestedParamTags(comment: Comment, parameter: ParameterReflection) {
                 }
             }
         },
+        reference(){
+            comment.blockTags.filter(
+                (t) =>
+                    t.tag === "@param" &&
+                    t.name?.startsWith(`${parameter.name}.`)
+            ).forEach(tag => {
+                const path = tag.name!.split(".");
+                path.shift();
+                if(!parameter.comment){
+                    parameter.comment = new Comment();
+                }
+                parameter.comment.blockTags.push(tag);
+            })
+
+        },
         // #1876, also do this for unions/intersections.
         union(u) {
             u.types.forEach((t) => t.visit(visitor));