aboutsummaryrefslogtreecommitdiff
path: root/scripts/apidoc/moduleMethods.ts
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2023-04-20 20:22:26 +0200
committerGitHub <[email protected]>2023-04-20 20:22:26 +0200
commita001ac5cf284d3027b9726f1f1f5f3fa14bc7bf4 (patch)
tree16282634fd7ef8954e8d2f4557d7e72dea735423 /scripts/apidoc/moduleMethods.ts
parent2098b4d20e9604c95ab24f2f89452a11ae5f49d7 (diff)
downloadfaker-a001ac5cf284d3027b9726f1f1f5f3fa14bc7bf4.tar.xz
faker-a001ac5cf284d3027b9726f1f1f5f3fa14bc7bf4.zip
docs: check api references (#2024)
Diffstat (limited to 'scripts/apidoc/moduleMethods.ts')
-rw-r--r--scripts/apidoc/moduleMethods.ts5
1 files changed, 3 insertions, 2 deletions
diff --git a/scripts/apidoc/moduleMethods.ts b/scripts/apidoc/moduleMethods.ts
index 9c902dd7..55b1869f 100644
--- a/scripts/apidoc/moduleMethods.ts
+++ b/scripts/apidoc/moduleMethods.ts
@@ -5,9 +5,10 @@ import type {
} from 'typedoc';
import type { Method } from '../../docs/.vitepress/components/api-docs/method';
import { writeApiDocsModule } from './apiDocsWriter';
-import { analyzeSignature, stripAbsoluteFakerUrls, toBlock } from './signature';
+import { analyzeSignature } from './signature';
import {
extractDeprecated,
+ extractDescription,
extractModuleFieldName,
extractModuleName,
selectApiMethodSignatures,
@@ -35,7 +36,7 @@ function processModule(module: DeclarationReflection): ModuleSummary {
const moduleName = extractModuleName(module);
const moduleFieldName = extractModuleFieldName(module);
console.log(`Processing Module ${moduleName}`);
- const comment = stripAbsoluteFakerUrls(toBlock(module.comment));
+ const comment = extractDescription(module);
const deprecated = extractDeprecated(module);
const methods = processModuleMethods(module, `faker.${moduleFieldName}.`);