docs: rewrite api-docs generation using ts-morph (#2628)

1 files changed, 33 insertions, 0 deletions

diff --git a/test/scripts/apidocs/class.example.ts b/test/scripts/apidocs/class.example.ts
new file mode 100644
index 00000000..0e5d9d89
--- /dev/null
+++ b/test/scripts/apidocs/class.example.ts
@@ -0,0 +1,33 @@
+/* eslint-disable @typescript-eslint/no-extraneous-class -- required for tests */
+
+/**
+ * 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 {}