feat(ngdoc): add @type custom type

docgeni · Aug 5, 2022 · b1ba6fd · b1ba6fd
1 parent dc8fd5d
commit b1ba6fd
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 2 deletions.
diff --git a/packages/ngdoc/src/ng-parser.ts b/packages/ngdoc/src/ng-parser.ts
@@ -165,7 +165,7 @@ export class NgDocParser {
                             name: symbolDescription.name,
                             aliasName: this.getNgPropertyAliasName(decorator),
                             type: {
-                                name: symbolDescription.type,
+                                name: getTextByJSDocTagInfo(tags.type, symbolDescription.type),
                                 options: options,
                                 kindName: ts.SyntaxKind[propertyDeclaration.type?.kind]
                             },

diff --git a/packages/ngdoc/src/parser/utils.ts b/packages/ngdoc/src/parser/utils.ts
@@ -173,6 +173,7 @@ export interface DocTagResult {
     default?: ts.JSDocTagInfo;
     deprecated?: ts.JSDocTagInfo;
     name?: ts.JSDocTagInfo;
+    type?: ts.JSDocTagInfo;
     [key: string]: ts.JSDocTagInfo;
 }
 export interface MethodDocTagResult {

diff --git a/packages/ngdoc/test/fixtures/full/input/button.component.ts b/packages/ngdoc/test/fixtures/full/input/button.component.ts
@@ -42,6 +42,7 @@ export class ButtonComponent implements OnInit {
 
     /**
      * Template
+     * @type TemplateRef
      */
     @ContentChild('template') templateRef: TemplateRef<unknown>;
 

diff --git a/packages/ngdoc/test/fixtures/full/output.json b/packages/ngdoc/test/fixtures/full/output.json
@@ -99,7 +99,7 @@
         "name": "templateRef",
         "aliasName": "template",
         "type": {
-          "name": "TemplateRef<unknown>",
+          "name": "TemplateRef",
           "options": null,
           "kindName": "TypeReference"
         },