aboutsummaryrefslogtreecommitdiff
path: root/test/scripts/apidoc/module.example.ts
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2023-09-22 09:44:19 +0200
committerGitHub <[email protected]>2023-09-22 09:44:19 +0200
commit7e274f3a0f42cb2c43f1e5bd1988b60c6a279fc5 (patch)
tree368f4f7a642d9d2ec483c6070542291726a3e4ac /test/scripts/apidoc/module.example.ts
parent005369b29c7ee290a870396ff0acc85e3f715e10 (diff)
downloadfaker-7e274f3a0f42cb2c43f1e5bd1988b60c6a279fc5.tar.xz
faker-7e274f3a0f42cb2c43f1e5bd1988b60c6a279fc5.zip
test: add more module jsdoc tests (#2412)
Diffstat (limited to 'test/scripts/apidoc/module.example.ts')
-rw-r--r--test/scripts/apidoc/module.example.ts14
1 files changed, 13 insertions, 1 deletions
diff --git a/test/scripts/apidoc/module.example.ts b/test/scripts/apidoc/module.example.ts
index 9671dc73..b3f43a86 100644
--- a/test/scripts/apidoc/module.example.ts
+++ b/test/scripts/apidoc/module.example.ts
@@ -1,4 +1,9 @@
/**
+ * 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()