Merge branch 'next' into 1686-padding-line-between-statements

Author: Shinigami92

scripts/apidoc/signature.ts

@@ -246,7 +246,7 @@ function analyzeParameterOptions(
       description: mdToHtml(
         toBlock(
           property.comment ??
-            (property.type as ReflectionType)?.declaration.signatures?.[0]
+            (property.type as ReflectionType)?.declaration?.signatures?.[0]
               .comment
         )
       ),

src/modules/helpers/index.ts

@@ -408,6 +408,7 @@ export class HelpersModule {
   /**
    * Returns a random key from given object or `undefined` if no key could be found.
    *
+   * @template T The type of the object to select from.
    * @param object The object to be used.
    *
    * @example
@@ -423,6 +424,7 @@ export class HelpersModule {
   /**
    * Returns a random value from given object or `undefined` if no key could be found.
    *
+   * @template T The type of object to select from.
    * @param object The object to be used.
    *
    * @example
@@ -801,6 +803,7 @@ export class HelpersModule {
   /**
    * Generates an array containing values returned by the given method.
    *
+   * @template T The type of elements.
    * @param method The method used to generate the values.
    * @param options The optional options object.
    * @param options.count The number or range of elements to generate. Defaults to `3`.

test/scripts/apidoc/examplesAndDeprecations.spec.ts

@@ -3,8 +3,20 @@ import { resolve } from 'node:path';
 import type { DeclarationReflection, SignatureReflection } from 'typedoc';
 import { ReflectionKind } from 'typedoc';
 import type { SpyInstance } from 'vitest';
-import { afterAll, beforeEach, describe, expect, it, vi } from 'vitest';
+import {
+  afterAll,
+  beforeAll,
+  beforeEach,
+  describe,
+  expect,
+  it,
+  vi,
+} from 'vitest';
 import { selectApiModules } from '../../../scripts/apidoc/moduleMethods';
+import {
+  analyzeSignature,
+  initMarkdownRenderer,
+} from '../../../scripts/apidoc/signature';
 import {
   extractRawExamples,
   extractSeeAlsos,
@@ -27,6 +39,8 @@ const locales: Record<string, string> = {
   DE: 'de',
 };
 
+beforeAll(initMarkdownRenderer);
+
 describe('examples and deprecations', () => {
   const project = loadProject();
 
@@ -107,6 +121,18 @@ describe('examples and deprecations', () => {
         }
       }
 
+      // Verify @param tags
+      analyzeSignature(signature, moduleName, methodName).parameters.forEach(
+        (param) => {
+          const { name, description } = param;
+          const plainDescription = description.replace(/<[^>]+>/g, '').trim();
+          expect(
+            plainDescription,
+            `Expect param ${name} to have a description`
+          ).not.toBe('Missing');
+        }
+      );
+
       // Verify @see tag
       extractSeeAlsos(signature).forEach((link) => {
         if (link.startsWith('faker.')) {