aboutsummaryrefslogtreecommitdiff
path: root/test/scripts/apidoc/module.example.ts
blob: b3f43a8602bf5beda3a6da6accf2fd94427fd770 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/**
 * 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/).
 */
export class ModuleFakerJsLinkTest {}

/**
 * Description with a link to our [website](https://next.fakerjs.dev/)
 * and [api docs](https://next.fakerjs.dev/api/).
 */
export class ModuleNextFakerJsLinkTest {}

/**
 * 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()
 */
export class ModuleExampleTest {}