Fix #2135

Author: Gerrit0

.vscode/launch.json

@@ -11,21 +11,21 @@
                 "--config",
                 "${workspaceFolder}/.config/mocha.fast.json",
                 "-g",
-                "1734"
+                "2135"
             ],
             "internalConsoleOptions": "openOnSessionStart",
             "name": "Debug Tests",
             "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
             "request": "launch",
             "skipFiles": ["<node_internals>/**"],
-            "type": "pwa-node"
+            "type": "node"
         },
         {
             "name": "Attach",
             "port": 9229,
             "request": "attach",
             "skipFiles": ["<node_internals>/**"],
-            "type": "pwa-node",
+            "type": "node",
             "sourceMaps": true
         }
     ]

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+### Bug Fixes
+
+-   Fixed an issue where signature comments were preferred over property comments for indirectly created function-properties, #2135.
+
 ## v0.23.23 (2022-12-18)
 
 ### Features

src/lib/converter/factories/signature.ts

@@ -43,13 +43,24 @@ export function createSignature(
         context.scope
     );
 
-    // If we are creating signatures for a variable and the variable has a comment associated with it
-    // then we should prefer that variable's comment over any comment on the signature. The comment plugin
+    // If we are creating signatures for a variable or property and it has a comment associated with it
+    // then we should prefer that comment over any comment on the signature. The comment plugin
     // will copy the comment down if this signature doesn't have one, so don't set one.
+    let parentReflection = context.scope;
+    if (
+        parentReflection.kindOf(ReflectionKind.TypeLiteral) &&
+        parentReflection.parent instanceof DeclarationReflection
+    ) {
+        parentReflection = parentReflection.parent;
+    }
+
     if (
         declaration &&
-        (!context.scope.comment ||
-            !(context.scope.conversionFlags & ConversionFlags.VariableSource))
+        (!parentReflection.comment ||
+            !(
+                parentReflection.conversionFlags &
+                ConversionFlags.VariableOrPropertySource
+            ))
     ) {
         sigRef.comment = getSignatureComment(
             declaration,

src/lib/converter/symbols.ts

@@ -623,6 +623,7 @@ function convertProperty(
         symbol,
         exportSymbol
     );
+    reflection.conversionFlags |= ConversionFlags.VariableOrPropertySource;
 
     const declaration = symbol.getDeclarations()?.[0];
     let parameterType: ts.TypeNode | undefined;
@@ -642,7 +643,7 @@ function convertProperty(
     reflection.defaultValue = declaration && convertDefaultValue(declaration);
 
     reflection.type = context.converter.convertType(
-        context,
+        context.withScope(reflection),
         (context.isConvertingTypeNode() ? parameterType : void 0) ??
             context.checker.getTypeOfSymbol(symbol)
     );
@@ -894,7 +895,7 @@ function convertVariableAsFunction(
         exportSymbol
     );
     setModifiers(symbol, accessDeclaration, reflection);
-    reflection.conversionFlags |= ConversionFlags.VariableSource;
+    reflection.conversionFlags |= ConversionFlags.VariableOrPropertySource;
     context.finalizeDeclarationReflection(reflection);
 
     const reflectionContext = context.withScope(reflection);

src/lib/models/reflections/declaration.ts

@@ -34,7 +34,7 @@ export interface DeclarationHierarchy {
  */
 export enum ConversionFlags {
     None = 0,
-    VariableSource = 1,
+    VariableOrPropertySource = 1,
 }
 
 /**

src/test/converter2/issues/gh2135.ts

@@ -0,0 +1,7 @@
+export class Camera {
+    /** One */
+    static useCameraPermissions = createPermissionHook();
+}
+
+/** Two */
+declare function createPermissionHook(): () => void;

src/test/issueTests.ts

@@ -825,4 +825,15 @@ export const issueTests: {
             "Foo type comment"
         );
     },
+
+    gh2135(project) {
+        const hook = query(project, "Camera.useCameraPermissions");
+        equal(hook.type?.type, "reflection" as const);
+        equal(
+            Comment.combineDisplayParts(
+                hook.type.declaration.signatures![0].comment?.summary
+            ),
+            "One"
+        );
+    },
 };