feat!: examples are now { name, content }

Co-authored-by: Willow (GHOST) <ghostdevv@users.noreply.github.com>

.changeset/sweet-ears-own.md

@@ -0,0 +1,5 @@
+---
+'extractinator': patch
+---
+
+breaking: examples are now `{ name, content }` instead of `string`

src/comments.ts

@@ -138,7 +138,15 @@ export function parseComment(commentString: string, parser: TSDocParser): TSDocC
 			switch (block.blockTag.tagName) {
 				case '@example':
 					found.examples ??= []
-					found.examples.push(render(block.content))
+					let content = render(block.content)
+
+					// If the first char is a space, remove it.
+					if (content.startsWith(' ')) {
+						content = content.slice(1)
+					}
+
+					const name = content.split('\n')?.[0]?.trim()
+					found.examples.push({ name, content: content.replace(name, '') })
 					break
 				case '@note':
 					found.notes ??= []

src/types.d.ts

@@ -168,7 +168,10 @@ export interface TSDocComment extends Modifiers {
 	defaultValue?: string
 	returns?: string
 	notes?: string[]
-	examples?: string[]
+	examples?: {
+		name?: string
+		content: string
+	}[]
 	seeBlocks?: string[]
 	customBlocks?: { tagName: string; content: string }[]
 	/** The raw tsdoc comment. */