feat: add jsdocs for symbol defintions

johnchourajr · May 30, 2024 · e6d9cd4 · e6d9cd4
1 parent d231e1a
commit e6d9cd4
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/jsr.json b/jsr.json
@@ -1,6 +1,6 @@
 {
   "name": "@buen/type",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "exports": "./src/index.ts",
   "publish": {
     "include": ["src/**/*.ts", "src/defaults.ts", "src/types.ts", "README.md"],

diff --git a/src/index.ts b/src/index.ts
@@ -73,14 +73,26 @@ export { buenTypeTailwind } from "./tailwind-plugin/buenTypeTailwind.ts";
  */
 export { createRemClamp } from "./utils/createRemClamp.ts";
 
+/**
+ * Types for the Buen Type module, for use when implementing custom type definitions.
+ *
+ * @module
+ */
 export type {
   CustomTypeDefinitions,
   TypeDefinition,
   TypeDefinitionHeadlines,
-  TypeDefinitionTexts,
+  TypeDefinitionTexts
 } from "./types.ts";
 
+
+/**
+ * Default objects for headline and text definitions.
+ *
+ * @module
+ */
 export {
   DEFAULT_HEADLINE as headlineDefault,
-  DEFAULT_TEXT as textDefault,
+  DEFAULT_TEXT as textDefault
 } from "./defaults.ts";
+