aboutsummaryrefslogtreecommitdiff
path: root/scripts/apidoc/moduleMethods.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 /scripts/apidoc/moduleMethods.ts
parent74eecccd3af702d8a1d8072f94032ccb54293cb1 (diff)
downloadfaker-24415ee993a9c6e3c8f0dffa544f492dcb29463c.tar.xz
faker-24415ee993a9c6e3c8f0dffa544f492dcb29463c.zip
infra: lint all existing jsdocs (#2408)
Diffstat (limited to 'scripts/apidoc/moduleMethods.ts')
-rw-r--r--scripts/apidoc/moduleMethods.ts5
1 files changed, 5 insertions, 0 deletions
diff --git a/scripts/apidoc/moduleMethods.ts b/scripts/apidoc/moduleMethods.ts
index 89f234db..33255a17 100644
--- a/scripts/apidoc/moduleMethods.ts
+++ b/scripts/apidoc/moduleMethods.ts
@@ -23,6 +23,7 @@ import { adjustUrls } from './utils';
* Analyzes and writes the documentation for modules and their methods such as `faker.animal.cat()`.
*
* @param project The project used to extract the modules.
+ *
* @returns The generated pages.
*/
export async function processModules(
@@ -35,6 +36,7 @@ export async function processModules(
* Analyzes and writes the documentation for a module and its methods such as `faker.animal.cat()`.
*
* @param module The module to process.
+ *
* @returns The generated pages.
*/
async function processModule(
@@ -63,6 +65,7 @@ async function processModule(
* Analyzes the documentation for a class.
*
* @param module The class to process.
+ *
* @returns The class information.
*/
export function analyzeModule(module: DeclarationReflection): {
@@ -85,6 +88,7 @@ export function analyzeModule(module: DeclarationReflection): {
*
* @param module The module to process.
* @param accessor The code used to access the methods within the module.
+ *
* @returns A list containing the documentation for the api methods in the given module.
*/
export async function processModuleMethods(
@@ -99,6 +103,7 @@ export async function processModuleMethods(
*
* @param signatures The signatures to process.
* @param accessor The code used to access the methods.
+ *
* @returns A list containing the documentation for the api methods.
*/
export async function processMethods(