fix(app): @link in @see JSDoc tag

fix #1104
compodoc · Sep 16, 2021 · ba13a85 · ba13a85
1 parent b31604c
commit ba13a85
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/src/utils/jsdoc-parser.util.ts b/src/utils/jsdoc-parser.util.ts
@@ -106,7 +106,13 @@ export class JsdocParserUtil {
 
             if (!inCode) {
                 const tag = /^@(\S+)/.exec(line);
-                if (tag) {
+                const SeeTag = /^@see/.exec(line);
+
+                if (SeeTag) {
+                    line = line.replace(/^@see/, 'See');
+                }
+
+                if (tag && !SeeTag) {
                     return;
                 }
             }

diff --git a/test/fixtures/todomvc-ng2/src/app/shared/services/todo.store.ts b/test/fixtures/todomvc-ng2/src/app/shared/services/todo.store.ts
@@ -104,7 +104,7 @@ export class TodoStore {
     /**
      * Remove todo
      *
-     * See {@link Todo}
+     * @see {@link Todo} for details
      *
      * @param {Todo} todo Todo to remove
      * @param {any[]} theArgs the rest of arguments

diff --git a/test/src/cli/cli-generation-big-app.spec.ts b/test/src/cli/cli-generation-big-app.spec.ts
@@ -859,4 +859,9 @@ describe('CLI simple generation - big app', () => {
             'A TodoStore -&gt; see <a href="../injectables/TodoStore.html">TodoStore'
         );
     });
+
+    it('should support JSDoc @link in JSDoc @see tag', () => {
+        let file = read(distFolder + '/injectables/TodoStore.html');
+        expect(file).to.contain('See <a href="../classes/Todo.html">Todo</a> for details');
+    });
 });