Fix missing comments on indirectly created var-fns

Resolves #2008

Author: Gerrit0

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### Bug Fixes
 
+-   Fixed missing comments on callable variable-functions constructed indirectly, #2008.
 -   Fixed multiple reflections mapping to the same file name on case insensitive file systems, #2012.
 
 ## v0.23.8 (2022-07-17)

package.json

@@ -66,7 +66,8 @@
     "/tsdoc.json"
   ],
   "scripts": {
-    "test": "c8 mocha -r ts-node/register --config .config/mocha.fast.json",
+    "test": "mocha -r ts-node/register --config .config/mocha.fast.json",
+    "test:cov": "c8 mocha -r ts-node/register --config .config/mocha.fast.json",
     "build:c2": "node bin/typedoc --tsconfig src/test/converter2/tsconfig.json",
     "test:full": "c8 mocha -r ts-node/register --config .config/mocha.full.json",
     "test:visual": "node ./dist/test/capture-screenshots.js && reg-suit -c .config/regconfig.json compare",

src/lib/converter/comments/discovery.ts

@@ -37,6 +37,9 @@ const wantedKinds: Record<ReflectionKind, ts.SyntaxKind[]> = {
     [ReflectionKind.Function]: [
         ts.SyntaxKind.FunctionDeclaration,
         ts.SyntaxKind.BindingElement,
+        ts.SyntaxKind.VariableDeclaration,
+        ts.SyntaxKind.ExportAssignment,
+        ts.SyntaxKind.PropertyAccessExpression,
     ],
     [ReflectionKind.Class]: [
         ts.SyntaxKind.ClassDeclaration,
@@ -106,8 +109,12 @@ export function discoverComment(
             // See the gh1770 test for an example.
             if (
                 kind & ReflectionKind.ContainsCallSignatures &&
-                !(node as ts.FunctionDeclaration).body &&
-                node.kind !== ts.SyntaxKind.BindingElement
+                [
+                    ts.SyntaxKind.FunctionDeclaration,
+                    ts.SyntaxKind.MethodDeclaration,
+                    ts.SyntaxKind.Constructor,
+                ].includes(node.kind) &&
+                !(node as ts.FunctionDeclaration).body
             ) {
                 continue;
             }

src/lib/converter/plugins/CommentPlugin.ts

@@ -439,11 +439,23 @@ export class CommentPlugin extends ConverterComponent {
             return false;
         }
 
-        return (
+        const isHidden =
             comment.hasModifier("@hidden") ||
             comment.hasModifier("@ignore") ||
-            (comment.hasModifier("@internal") && this.excludeInternal)
-        );
+            (comment.hasModifier("@internal") && this.excludeInternal);
+
+        if (
+            isHidden &&
+            reflection.kindOf(ReflectionKind.ContainsCallSignatures)
+        ) {
+            return (reflection as DeclarationReflection)
+                .getNonIndexSignatures()
+                .every((sig) => {
+                    return !sig.comment || this.isHidden(sig);
+                });
+        }
+
+        return isHidden;
     }
 }
 

src/test/converter/function/specs.json

@@ -449,6 +449,14 @@
               "kind": 4096,
               "kindString": "Call signature",
               "flags": {},
+              "comment": {
+                "summary": [
+                  {
+                    "kind": "text",
+                    "text": "Returns true if fn returns true for every item in the iterator\n\nReturns true if the iterator is empty"
+                  }
+                ]
+              },
               "typeParameter": [
                 {
                   "id": 101,
@@ -543,6 +551,14 @@
               "kind": 4096,
               "kindString": "Call signature",
               "flags": {},
+              "comment": {
+                "summary": [
+                  {
+                    "kind": "text",
+                    "text": "Returns true if fn returns true for every item in the iterator\n\nReturns true if the iterator is empty"
+                  }
+                ]
+              },
               "typeParameter": [
                 {
                   "id": 108,

src/test/converter2/issues/gh2008.ts

@@ -0,0 +1,4 @@
+const makeFn = () => () => {};
+
+/** Docs */
+export const myFn = makeFn();

src/test/converter2/validation/interface.ts

@@ -0,0 +1,5 @@
+export interface Foo {
+    /** a */
+    method(): void;
+    method(a: string): string;
+}

src/test/issueTests.ts

@@ -666,6 +666,11 @@ export const issueTests: {
         equal(b.signatures![0].sources?.[0].character, 0);
     },
 
+    gh2008(project) {
+        const fn = query(project, "myFn").signatures![0];
+        equal(Comment.combineDisplayParts(fn.comment?.summary), "Docs");
+    },
+
     gh2012(project) {
         project.hasOwnDocument = true;
         const model = query(project, "model");

src/test/validation.test.ts

@@ -195,4 +195,15 @@ describe("validateDocumentation", () => {
         );
         logger.expectNoOtherMessages();
     });
+
+    it("Should correctly handle interfaces", () => {
+        const project = convertValidationFile("interface.ts");
+        const logger = new TestLogger();
+        validateDocumentation(project, logger, ["Method"]);
+
+        logger.expectMessage(
+            "warn: Foo.method does not have any documentation."
+        );
+        logger.expectNoOtherMessages();
+    });
 });