aboutsummaryrefslogtreecommitdiff
path: root/test/scripts/apidoc/utils.ts
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2023-09-24 01:24:37 +0200
committerGitHub <[email protected]>2023-09-23 23:24:37 +0000
commit24415ee993a9c6e3c8f0dffa544f492dcb29463c (patch)
treebce36d80dbd989b8cd9fbbf47be411d14fd167d4 /test/scripts/apidoc/utils.ts
parent74eecccd3af702d8a1d8072f94032ccb54293cb1 (diff)
downloadfaker-24415ee993a9c6e3c8f0dffa544f492dcb29463c.tar.xz
faker-24415ee993a9c6e3c8f0dffa544f492dcb29463c.zip
infra: lint all existing jsdocs (#2408)
Diffstat (limited to 'test/scripts/apidoc/utils.ts')
-rw-r--r--test/scripts/apidoc/utils.ts3
1 files changed, 3 insertions, 0 deletions
diff --git a/test/scripts/apidoc/utils.ts b/test/scripts/apidoc/utils.ts
index 095592c5..ade31120 100644
--- a/test/scripts/apidoc/utils.ts
+++ b/test/scripts/apidoc/utils.ts
@@ -12,6 +12,9 @@ import { mapByName } from '../../../scripts/apidoc/utils';
/**
* Returns a record with the (Module-Name -> (Method-Name -> Method-Signature)) for the project.
+ *
+ * @param options The TypeDoc options.
+ * @param includeTestModules Whether to include the test modules.
*/
export function loadProjectModules(
options?: Partial<TypeDocOptions>,