feat: add a doc. comment for the module

chalkpot · Dec 12, 2023 · 2450466 · 2450466
1 parent f52fc01
commit 2450466
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/_wrapper/wrapper.ts b/_wrapper/wrapper.ts
@@ -203,7 +203,14 @@ try {
   await Deno.writeFile(
     join(ROOT_DIR, INDEX_FILE),
     new TextEncoder().encode(
-      `${thisFileCopyright}\n\n` + `${WARNING}\n\n` + fileExports.join("\n"),
+      `${thisFileCopyright}\n\n` + `${WARNING}\n\n` +
+        "/**\n" +
+        " * Color convert is a set of conversion functions and automated\n" +
+        " * conversions of color models and formats.\n" +
+        " *\n" +
+        " * @module\n" +
+        " */\n\n" +
+        fileExports.join("\n"),
     ),
   );
 

diff --git a/mod.ts b/mod.ts
@@ -3,6 +3,13 @@
 // File generated automatically!
 // Generation script: /color_convert/_wrapper/wrapper.ts
 
+/**
+ * Color convert is a set of conversion functions and automated
+ * conversions of color models and formats.
+ *
+ * @module
+ */
+
 export * from "./wrap_ansi16.ts"
 export * from "./ansi256/ansi256_to_rgb.ts";
 export * from "./cmyk/cmyk_to_rgb.ts";