diff options
| author | ST-DDT <[email protected]> | 2023-04-28 15:23:50 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-04-28 13:23:50 +0000 |
| commit | 3cfeb3814703d12a9e95ed684fc2c8f94d1f2c72 (patch) | |
| tree | 0c9f4148244bfd02d9131132366ff59a8b941673 /scripts/apidoc/fakerClass.ts | |
| parent | 971f36371bf924b334cb7766fd87afa7b484119a (diff) | |
| download | faker-3cfeb3814703d12a9e95ed684fc2c8f94d1f2c72.tar.xz faker-3cfeb3814703d12a9e95ed684fc2c8f94d1f2c72.zip | |
docs: fix full url to absolute conversion (#2101)
Diffstat (limited to 'scripts/apidoc/fakerClass.ts')
| -rw-r--r-- | scripts/apidoc/fakerClass.ts | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/scripts/apidoc/fakerClass.ts b/scripts/apidoc/fakerClass.ts index c3a5287d..f8de8653 100644 --- a/scripts/apidoc/fakerClass.ts +++ b/scripts/apidoc/fakerClass.ts @@ -2,9 +2,9 @@ import type { DeclarationReflection, ProjectReflection } from 'typedoc'; import { ReflectionKind } from 'typedoc'; import type { Method } from '../../docs/.vitepress/components/api-docs/method'; import { writeApiDocsModule } from './apiDocsWriter'; -import { processModuleMethods } from './moduleMethods'; +import { analyzeModule, processModuleMethods } from './moduleMethods'; import { analyzeSignature } from './signature'; -import { extractDescription, selectApiSignature } from './typedoc'; +import { selectApiSignature } from './typedoc'; import type { ModuleSummary } from './utils'; export function processFakerClass(project: ProjectReflection): ModuleSummary { @@ -21,7 +21,7 @@ export function processFakerClass(project: ProjectReflection): ModuleSummary { function processClass(fakerClass: DeclarationReflection): ModuleSummary { console.log(`Processing Faker class`); - const comment = extractDescription(fakerClass); + const { comment, deprecated } = analyzeModule(fakerClass); const methods: Method[] = []; console.debug(`- constructor`); @@ -29,7 +29,7 @@ function processClass(fakerClass: DeclarationReflection): ModuleSummary { methods.push(...processModuleMethods(fakerClass, 'faker.')); - return writeApiDocsModule('Faker', 'faker', comment, undefined, methods); + return writeApiDocsModule('Faker', 'faker', comment, deprecated, methods); } function processConstructor(fakerClass: DeclarationReflection): Method { |
