diff --git a/test/scripts/apidoc/__snapshots__/module.spec.ts.snap b/test/scripts/apidoc/__snapshots__/module.spec.ts.snap index a7a2ec01c94..3afdab63b01 100644 --- a/test/scripts/apidoc/__snapshots__/module.spec.ts.snap +++ b/test/scripts/apidoc/__snapshots__/module.spec.ts.snap @@ -1,8 +1,16 @@ // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html +exports[`module > analyzeModule() > ModuleDeprecationTest 1`] = ` +{ + "comment": "This is a description for a module with a code example.", + "deprecated": "Well, this is deprecated.", + "examples": undefined, +} +`; + exports[`module > analyzeModule() > ModuleExampleTest 1`] = ` { - "comment": "This is a description for a module with a code example", + "comment": "This is a description for a module with a code example.", "deprecated": undefined, "examples": "
ts
new ModuleExampleTest()
", @@ -27,10 +35,20 @@ and [api docs](/api/).", } `; +exports[`module > analyzeModule() > ModuleSimpleTest 1`] = ` +{ + "comment": "A simple module without anything special.", + "deprecated": undefined, + "examples": undefined, +} +`; + exports[`module > analyzeModule() > expected and actual modules are equal 1`] = ` [ + "ModuleDeprecationTest", "ModuleExampleTest", "ModuleFakerJsLinkTest", "ModuleNextFakerJsLinkTest", + "ModuleSimpleTest", ] `; diff --git a/test/scripts/apidoc/module.example.ts b/test/scripts/apidoc/module.example.ts index 9671dc73605..b3f43a8602b 100644 --- a/test/scripts/apidoc/module.example.ts +++ b/test/scripts/apidoc/module.example.ts @@ -1,3 +1,8 @@ +/** + * A simple module without anything special. + */ +export class ModuleSimpleTest {} + /** * Description with a link to our [website](https://fakerjs.dev/) * and [api docs](https://fakerjs.dev/api/). @@ -11,7 +16,14 @@ export class ModuleFakerJsLinkTest {} export class ModuleNextFakerJsLinkTest {} /** - * This is a description for a module with a code example + * This is a description for a module with a code example. + * + * @deprecated Well, this is deprecated. + */ +export class ModuleDeprecationTest {} + +/** + * This is a description for a module with a code example. * * @example * new ModuleExampleTest()