docs: show examples for modules (#2406)

Co-authored-by: ST-DDT <[email protected]>

3 files changed, 23 insertions, 3 deletions

diff --git a/test/scripts/apidoc/__snapshots__/module.spec.ts.snap b/test/scripts/apidoc/__snapshots__/module.spec.ts.snap
index b3584e13..a7a2ec01 100644
--- a/test/scripts/apidoc/__snapshots__/module.spec.ts.snap
+++ b/test/scripts/apidoc/__snapshots__/module.spec.ts.snap
@@ -1,10 +1,20 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`module > analyzeModule() > ModuleExampleTest 1`] = `
+{
+  "comment": "This is a description for a module with a code example",
+  "deprecated": undefined,
+  "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#89DDFF\\">new</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#82AAFF\\">ModuleExampleTest</span><span style=\\"color:#BABED8\\">()</span></span></code></pre>
+</div>",
+}
+`;
+
 exports[`module > analyzeModule() > ModuleFakerJsLinkTest 1`] = `
 {
   "comment": "Description with a link to our [website](/)
 and [api docs](/api/).",
   "deprecated": undefined,
+  "examples": undefined,
 }
 `;
 
@@ -13,11 +23,13 @@ exports[`module > analyzeModule() > ModuleNextFakerJsLinkTest 1`] = `
   "comment": "Description with a link to our [website](/)
 and [api docs](/api/).",
   "deprecated": undefined,
+  "examples": undefined,
 }
 `;
 
 exports[`module > analyzeModule() > expected and actual modules are equal 1`] = `
 [
+  "ModuleExampleTest",
   "ModuleFakerJsLinkTest",
   "ModuleNextFakerJsLinkTest",
 ]
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 {}
diff --git a/test/scripts/apidoc/verify-jsdoc-tags.spec.ts b/test/scripts/apidoc/verify-jsdoc-tags.spec.ts
index 557504c8..586605a6 100644
--- a/test/scripts/apidoc/verify-jsdoc-tags.spec.ts
+++ b/test/scripts/apidoc/verify-jsdoc-tags.spec.ts
@@ -7,8 +7,8 @@ import { analyzeSignature } from '../../../scripts/apidoc/signature';
 import {
   extractDeprecated,
   extractDescription,
+  extractJoinedRawExamples,
   extractModuleFieldName,
-  extractRawExamples,
   extractSeeAlsos,
   extractSince,
   extractTagContent,
@@ -110,7 +110,7 @@ describe('verify JSDoc tags', () => {
             // Write temp files to disk
 
             // Extract examples and make them runnable
-            const examples = extractRawExamples(signature).join('').trim();
+            const examples = extractJoinedRawExamples(signature);
 
             // Save examples to a file to run them later in the specific tests
             const dir = resolveDirToModule(moduleName);
@@ -135,7 +135,7 @@ describe('verify JSDoc tags', () => {
 
           it('verify @example tag', async () => {
             // Extract the examples
-            const examples = extractRawExamples(signature).join('').trim();
+            const examples = extractJoinedRawExamples(signature);
 
             expect(
               examples,