fix: Missing comments on variable functions

Closes #1421

Author: Gerrit0

src/lib/converter/factories/comment.ts

@@ -211,9 +211,6 @@ export function parseComment(
         }
 
         currentTag = new CommentTag(tagName, paramName, line);
-        if (!comment.tags) {
-            comment.tags = [];
-        }
         comment.tags.push(currentTag);
     }
 

src/lib/converter/factories/signature.ts

@@ -23,7 +23,8 @@ export function createSignature(
         | ReflectionKind.GetSignature
         | ReflectionKind.SetSignature,
     signature: ts.Signature,
-    declaration?: ts.SignatureDeclaration
+    declaration?: ts.SignatureDeclaration,
+    commentDeclaration?: ts.Node
 ) {
     assert(context.scope instanceof DeclarationReflection);
     // signature.getDeclaration might return undefined.
@@ -32,14 +33,10 @@ export function createSignature(
         | ts.SignatureDeclaration
         | undefined;
 
-    let commentDeclaration: ts.Node | undefined = declaration;
-    if (
-        commentDeclaration &&
-        (ts.isArrowFunction(commentDeclaration) ||
-            ts.isFunctionExpression(commentDeclaration))
-    ) {
-        commentDeclaration = commentDeclaration.parent;
+    if (!commentDeclaration && declaration && (ts.isArrowFunction(declaration) || ts.isFunctionExpression(declaration)) {
+        commentDeclaration = declaration.parent;
     }
+    commentDeclaration ??= declaration;
 
     const sigRef = new SignatureReflection(
         context.scope.name,

src/lib/converter/plugins/CategoryPlugin.ts

@@ -177,15 +177,13 @@ export class CategoryPlugin extends ConverterComponent {
     static getCategory(reflection: Reflection): string {
         function extractCategoryTag(comment: Comment) {
             const tags = comment.tags;
-            if (tags) {
-                const tagIndex = tags.findIndex(
-                    (tag) => tag.tagName === "category"
-                );
-                if (tagIndex >= 0) {
-                    const tag = tags[tagIndex].text;
-                    tags.splice(tagIndex, 1);
-                    return tag.trim();
-                }
+            const tagIndex = tags.findIndex(
+                (tag) => tag.tagName === "category"
+            );
+            if (tagIndex >= 0) {
+                const tag = tags[tagIndex].text;
+                tags.splice(tagIndex, 1);
+                return tag.trim();
             }
             return "";
         }

src/lib/converter/symbols.ts

@@ -748,7 +748,9 @@ function convertVariableAsFunction(
             createSignature(
                 reflectionContext,
                 ReflectionKind.CallSignature,
-                signature
+                signature,
+                void 0,
+                declaration
             )
         );
     }

src/lib/models/comments/comment.ts

@@ -1,10 +1,11 @@
+import { removeIf } from "../../utils";
 import { CommentTag } from "./tag";
 
 /**
- * A model that represents a javadoc comment.
+ * A model that represents a comment.
  *
- * Instances of this model are created by the [[CommentHandler]]. You can retrieve comments
- * through the [[BaseReflection.comment]] property.
+ * Instances of this model are created by the [[CommentPlugin]]. You can retrieve comments
+ * through the [[DeclarationReflection.comment]] property.
  */
 export class Comment {
     /**
@@ -24,9 +25,9 @@ export class Comment {
     returns?: string;
 
     /**
-     * All associated javadoc tags.
+     * All associated tags.
      */
-    tags?: CommentTag[];
+    tags: CommentTag[] = [];
 
     /**
      * Creates a new Comment instance.
@@ -42,7 +43,7 @@ export class Comment {
      * @returns TRUE when this comment has a visible component.
      */
     hasVisibleComponent(): boolean {
-        return !!this.shortText || !!this.text || !!this.tags;
+        return !!this.shortText || !!this.text || this.tags.length > 0;
     }
 
     /**
@@ -52,15 +53,7 @@ export class Comment {
      * @returns TRUE when this comment contains a tag with the given name, otherwise FALSE.
      */
     hasTag(tagName: string): boolean {
-        if (!this.tags) {
-            return false;
-        }
-        for (let i = 0, c = this.tags.length; i < c; i++) {
-            if (this.tags[i].tagName === tagName) {
-                return true;
-            }
-        }
-        return false;
+        return this.tags.some((tag) => tag.tagName === tagName);
     }
 
     /**
@@ -73,7 +66,7 @@ export class Comment {
      * @returns The found tag or undefined.
      */
     getTag(tagName: string, paramName?: string): CommentTag | undefined {
-        return (this.tags || []).find((tag) => {
+        return this.tags.find((tag) => {
             return (
                 tag.tagName === tagName &&
                 (paramName === void 0 || tag.paramName === paramName)
@@ -86,20 +79,7 @@ export class Comment {
      * @param tagName
      */
     removeTags(tagName: string) {
-        if (!this.tags) {
-            return;
-        }
-
-        let i = 0,
-            c = this.tags.length ?? 0;
-        while (i < c) {
-            if (this.tags[i].tagName === tagName) {
-                this.tags.splice(i, 1);
-                c--;
-            } else {
-                i++;
-            }
-        }
+        removeIf(this.tags, (tag) => tag.tagName === tagName);
     }
 
     /**
@@ -111,10 +91,8 @@ export class Comment {
         this.shortText = comment.shortText;
         this.text = comment.text;
         this.returns = comment.returns;
-        this.tags = comment.tags
-            ? comment.tags.map(
-                  (tag) => new CommentTag(tag.tagName, tag.paramName, tag.text)
-              )
-            : undefined;
+        this.tags = comment.tags.map(
+            (tag) => new CommentTag(tag.tagName, tag.paramName, tag.text)
+        );
     }
 }

src/lib/serialization/serializers/comments/comment.ts

@@ -27,7 +27,7 @@ export class CommentSerializer extends SerializerComponent<Comment> {
         if (comment.returns) {
             obj.returns = comment.returns;
         }
-        if (comment.tags && comment.tags.length) {
+        if (comment.tags.length) {
             obj.tags = comment.tags.map((tag) => this.owner.toObject(tag));
         }
 

src/lib/utils/array.ts

@@ -59,6 +59,20 @@ export function removeIfPresent<T>(arr: T[] | undefined, item: T) {
     }
 }
 
+/**
+ * Remove items in an array which match a predicate.
+ * @param arr
+ * @param predicate
+ */
+export function removeIf<T>(arr: T[], predicate: (item: T) => boolean) {
+    const indices = filterMap(arr, (item, index) =>
+        predicate(item) ? index : void 0
+    );
+    for (const index of indices.reverse()) {
+        arr.splice(index, 1);
+    }
+}
+
 /**
  * Filters out duplicate values from the given iterable.
  * @param arr

src/lib/utils/index.ts

@@ -31,7 +31,14 @@ export type IfInternal<T, F> = InternalOnly extends true ? T : F;
 export type NeverIfInternal<T> = IfInternal<never, T>;
 
 export { Options, ParameterType, ParameterHint, BindOption } from "./options";
-export { insertPrioritySorted, removeIfPresent } from "./array";
+export {
+    insertPrioritySorted,
+    removeIfPresent,
+    removeIf,
+    filterMap,
+    unique,
+    uniqueByEquals,
+} from "./array";
 export { Component, AbstractComponent, ChildableComponent } from "./component";
 export { Event, EventDispatcher } from "./events";
 export {

src/test/converter/function/function.ts

@@ -188,3 +188,13 @@ export class Predicates {
     static assert(x: unknown): asserts x {}
     assertString(): asserts this is string {}
 }
+
+/**
+ * Returns true if fn returns true for every item in the iterator
+ *
+ * Returns true if the iterator is empty
+ */
+export const all: {
+    <T>(fn: (item: T) => boolean, iterator: Iterable<T>): boolean;
+    <T>(fn: (item: T) => boolean): (iterator: Iterable<T>) => boolean;
+} = () => false as any;