docs: Add module docs

scrapbox-jp · Aug 2, 2024 · afe8ba4 · afe8ba4
1 parent 894622f
commit afe8ba4
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/mod.ts b/mod.ts
diff --git a/rest.ts b/rest.ts
@@ -1,4 +1,7 @@
-/** @module types used at REST API */
+/**  type definitions for Cosense REST API responses
+ *
+ * @module
+ */
 
 export * from "./base.ts";
 export * from "./commit.ts";

diff --git a/userscript.ts b/userscript.ts
@@ -1,5 +1,7 @@
-/** @module types used at UserScript */
-
+/**  type definitions for Cosense UserScript
+ *
+ * @module
+ */
 export * from "./base.ts";
 export * from "./blocks.ts";
 export * from "./node/node.ts";