From f9411c90d02e8f716283c30accca022eb5e68031 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sat, 1 Apr 2023 14:46:36 +0200 Subject: docs: mark deprecated modules (#2000) --- scripts/apidoc/moduleMethods.ts | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'scripts/apidoc/moduleMethods.ts') diff --git a/scripts/apidoc/moduleMethods.ts b/scripts/apidoc/moduleMethods.ts index cdd9222e..20cbc2b8 100644 --- a/scripts/apidoc/moduleMethods.ts +++ b/scripts/apidoc/moduleMethods.ts @@ -3,6 +3,7 @@ import type { Method } from '../../docs/.vitepress/components/api-docs/method'; import { writeApiDocsData, writeApiDocsModulePage } from './apiDocsWriter'; import { analyzeSignature, stripAbsoluteFakerUrls, toBlock } from './signature'; import { + extractDeprecated, extractModuleFieldName, extractModuleName, selectApiMethodSignatures, @@ -41,7 +42,7 @@ function processModuleMethod(module: DeclarationReflection): PageAndDiffIndex { const moduleFieldName = extractModuleFieldName(module); console.log(`Processing Module ${moduleName}`); const comment = stripAbsoluteFakerUrls(toBlock(module.comment)); - + const deprecated = extractDeprecated(module); const methods: Method[] = []; // Generate method section @@ -52,7 +53,13 @@ function processModuleMethod(module: DeclarationReflection): PageAndDiffIndex { methods.push(analyzeSignature(signature, moduleFieldName, methodName)); } - writeApiDocsModulePage(moduleName, moduleFieldName, comment, methods); + writeApiDocsModulePage( + moduleName, + moduleFieldName, + comment, + deprecated, + methods + ); writeApiDocsData(moduleFieldName, methods); return [ -- cgit v1.2.3