feat: Support for @template

Closes #860
TypeStrong · Mar 15, 2020 · c015fd9 · c015fd9
1 parent 0e6ff69
commit c015fd9
Show file tree

Hide file tree

Showing 5 changed files with 110 additions and 46 deletions.
diff --git a/src/lib/converter/factories/comment.ts b/src/lib/converter/factories/comment.ts
@@ -170,7 +170,7 @@ export function parseComment(text: string, comment: Comment = new Comment()): Co
         line = tag[2].trim();
 
         if (tagName === 'return') { tagName = 'returns'; }
-        if (tagName === 'param' || tagName === 'typeparam') {
+        if (tagName === 'param' || tagName === 'typeparam' || tagName === 'template') {
             line = consumeTypeData(line);
             const param = /[^\s]+/.exec(line);
             if (param) {

diff --git a/src/lib/converter/plugins/CommentPlugin.ts b/src/lib/converter/plugins/CommentPlugin.ts
@@ -162,6 +162,9 @@ export class CommentPlugin extends ConverterComponent {
         const comment = reflection.parent && reflection.parent.comment;
         if (comment) {
             let tag = comment.getTag('typeparam', reflection.name);
+            if (!tag) {
+                tag = comment.getTag('template', reflection.name);
+            }
             if (!tag) {
                 tag = comment.getTag('param', `<${reflection.name}>`);
             }

diff --git a/src/lib/converter/plugins/DeepCommentPlugin.ts b/src/lib/converter/plugins/DeepCommentPlugin.ts
@@ -53,6 +53,9 @@ export class DeepCommentPlugin extends ConverterComponent {
                     let tag: CommentTag | undefined;
                     if (reflection instanceof TypeParameterReflection) {
                         tag = target.comment.getTag('typeparam', reflection.name);
+                        if (!tag) {
+                            tag = target.comment.getTag('template', reflection.name);
+                        }
                         if (!tag) {
                             tag = target.comment.getTag('param', '<' + reflection.name + '>');
                         }

diff --git a/src/test/converter/function/generic-function.ts b/src/test/converter/function/generic-function.ts
@@ -19,4 +19,12 @@ function functionWithGenericArrayParameter<T>(param: T, params: T[]): T[] {
     return params;
 }
 
+/**
+ * @param param this describes param
+ * @template T this describes T
+ */
+function functionWithTemplate<T>(param: T): T {
+    return param;
+}
+
 export {};