From a001ac5cf284d3027b9726f1f1f5f3fa14bc7bf4 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Thu, 20 Apr 2023 20:22:26 +0200 Subject: docs: check api references (#2024) --- scripts/apidoc/moduleMethods.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'scripts/apidoc/moduleMethods.ts') 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}.`); -- cgit v1.2.3