Correct handling of comment tags on function type aliases

Resolves #1734.

CHANGELOG.md

@@ -5,6 +5,7 @@
 -   Fixed flash when navigating to a second page when OS theme does not match selected theme, #1709.
 -   Fixed improper quoting of `as const` style enums, #1727.
 -   Fixed handling of `@typeParam` on type aliases, #1733.
+-   Fixed handling of comment tags on function type aliases, #1734.
 
 ### Thanks!
 

src/lib/converter/plugins/CommentPlugin.ts

@@ -346,7 +346,9 @@ export class CommentPlugin extends ConverterComponent {
                 childComment.shortText ||= comment.shortText;
                 childComment.text ||= comment.text;
                 childComment.returns ||= comment.returns;
-                childComment.tags ||= [...comment.tags];
+                childComment.tags = childComment.tags.length
+                    ? childComment.tags
+                    : [...comment.tags];
             }
 
             signature.parameters?.forEach((parameter, index) => {

src/test/converter.test.ts

@@ -1,7 +1,6 @@
 import { deepStrictEqual as equal, ok } from "assert";
 import * as FS from "fs";
 import * as Path from "path";
-import type * as ts from "typescript";
 import { normalizePath, ProjectReflection, resetReflectionID } from "..";
 import { getExpandedEntryPointsForPaths } from "../lib/utils";
 import {
@@ -13,10 +12,9 @@ import {
 describe("Converter", function () {
     const base = getConverterBase();
     const app = getConverterApp();
-    let program: ts.Program;
 
     it("Compiles", () => {
-        program = getConverterProgram();
+        getConverterProgram();
     });
 
     const checks: [string, () => void, () => void][] = [
@@ -63,7 +61,7 @@ describe("Converter", function () {
                         app.logger,
                         [path],
                         app.options,
-                        [program]
+                        [getConverterProgram()]
                     );
                     ok(entryPoints, "Failed to get entry points");
                     result = app.converter.convert(entryPoints);

src/test/converter2.test.ts

@@ -1,7 +1,6 @@
 import { ok } from "assert";
 import { existsSync } from "fs";
 import { join } from "path";
-import type * as ts from "typescript";
 import type { ProjectReflection } from "../lib/models";
 import { behaviorTests } from "./behaviorTests";
 import { issueTests } from "./issueTests";
@@ -13,14 +12,15 @@ import {
 
 const base = getConverter2Base();
 const app = getConverter2App();
-let program: ts.Program;
 
 function runTest(
     title: string,
     entry: string,
     check: (project: ProjectReflection) => void
 ) {
     it(title, () => {
+        const program = getConverter2Program();
+
         const entryPoint = [
             join(base, `${entry}.ts`),
             join(base, `${entry}.d.ts`),
@@ -46,7 +46,7 @@ function runTest(
 
 describe("Converter2", () => {
     it("Compiles", () => {
-        program = getConverter2Program();
+        getConverter2Program();
     });
 
     for (const [entry, check] of Object.entries(issueTests)) {

src/test/converter2/issues/gh1734.ts

@@ -0,0 +1,4 @@
+/**
+ * @asdf Some example text
+ */
+export type Foo = (arg: string) => string;

src/test/issueTests.ts

@@ -5,6 +5,9 @@ import {
     QueryType,
     ReflectionKind,
     SignatureReflection,
+    ReflectionType,
+    Comment,
+    CommentTag,
 } from "../lib/models";
 
 function query(project: ProjectReflection, name: string) {
@@ -242,4 +245,17 @@ export const issueTests: {
         const cls = query(project, "Bar");
         equal(cls.typeParameters?.[0].comment?.shortText.trim(), "T docs");
     },
+
+    gh1734(project) {
+        const alias = query(project, "Foo");
+        const type = alias.type;
+        ok(type instanceof ReflectionType);
+
+        const expectedComment = new Comment();
+        expectedComment.returns = undefined;
+        expectedComment.tags = [
+            new CommentTag("asdf", void 0, "Some example text\n"),
+        ];
+        equal(type.declaration.signatures?.[0].comment, expectedComment);
+    },
 };