From 7c4ffa56eccf4a5c15e50438e7ba2ab34a80889e Mon Sep 17 00:00:00 2001
From: Benjamin Canac <canacb1@gmail.com>
Date: Tue, 8 Oct 2024 11:58:23 +0200
Subject: [PATCH] chore(module): improve tsdoc

---
 src/module.ts | 24 +++++++++++++++++-------
 1 file changed, 17 insertions(+), 7 deletions(-)

diff --git a/src/module.ts b/src/module.ts
index 96d94874..6277323a 100644
--- a/src/module.ts
+++ b/src/module.ts
@@ -9,32 +9,41 @@ export type * from './runtime/types'
 export interface ModuleOptions {
   /**
    * Prefix for components
-   * @defaultValue U
+   * @defaultValue `U`
+   * @see https://ui3.nuxt.dev/getting-started/installation#prefix
    */
   prefix?: string
 
   /**
    * Enable or disable `@nuxt/fonts` module
-   * @defaultValue true
+   * @defaultValue `true`
+   * @see https://ui3.nuxt.dev/getting-started/installation#fonts
    */
   fonts?: boolean
 
   /**
    * Enable or disable `@nuxtjs/color-mode` module
-   * @defaultValue true
+   * @defaultValue `true`
+   * @see https://ui3.nuxt.dev/getting-started/installation#colormode
    */
   colorMode?: boolean
 
+  /**
+   * Customize how the theme is generated
+   * @see https://ui3.nuxt.dev/getting-started/theme
+   */
   theme?: {
     /**
-     * Colors to generate classes for (defaults to TailwindCSS colors)
-     * @defaultValue ['primary', 'secondary', 'success', 'info', 'warning', 'error']
+     * Define the color aliases available for components
+     * @defaultValue `['primary', 'secondary', 'success', 'info', 'warning', 'error']`
+     * @see https://ui3.nuxt.dev/getting-started/installation#themecolors
      */
     colors?: string[]
 
     /**
      * Enable or disable transitions on components
-     * @defaultValue true
+     * @defaultValue `true`
+     * @see https://ui3.nuxt.dev/getting-started/installation#themetransitions
      */
     transitions?: boolean
   }
@@ -46,7 +55,8 @@ export default defineNuxtModule<ModuleOptions>({
     configKey: 'ui',
     compatibility: {
       nuxt: '>=3.13.1'
-    }
+    },
+    docs: 'https://ui3.nuxt.dev/getting-started/installation'
   },
   defaults: {
     prefix: 'U',