diff options
| author | Matt Mayer <[email protected]> | 2023-09-20 02:47:34 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-09-19 21:47:34 +0200 |
| commit | 8e4172ba28381fd20eaa598234c63186631fd6fc (patch) | |
| tree | cbfc9f3b7f574036fa4a98f3d788b4c19540b6bc /test/scripts/apidoc/module.example.ts | |
| parent | d264100c80698ffdb471c39798420c98b1fa3c97 (diff) | |
| download | faker-8e4172ba28381fd20eaa598234c63186631fd6fc.tar.xz faker-8e4172ba28381fd20eaa598234c63186631fd6fc.zip | |
docs: show examples for modules (#2406)
Co-authored-by: ST-DDT <[email protected]>
Diffstat (limited to 'test/scripts/apidoc/module.example.ts')
| -rw-r--r-- | test/scripts/apidoc/module.example.ts | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/test/scripts/apidoc/module.example.ts b/test/scripts/apidoc/module.example.ts index ef646659..9671dc73 100644 --- a/test/scripts/apidoc/module.example.ts +++ b/test/scripts/apidoc/module.example.ts @@ -9,3 +9,11 @@ export class ModuleFakerJsLinkTest {} * and [api docs](https://next.fakerjs.dev/api/). */ export class ModuleNextFakerJsLinkTest {} + +/** + * This is a description for a module with a code example + * + * @example + * new ModuleExampleTest() + */ +export class ModuleExampleTest {} |