Refactor build function and add JSDoc comments

RA9 · Oct 5, 2024 · fdea69c · fdea69c
1 parent ea81d00
commit fdea69c
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/build.ts b/build.ts
@@ -1,6 +1,9 @@
 import { DescribeOptions } from './types.ts';
 
-// Define the build function with type annotations
+/**
+ * 
+ *  Builds a custom component with the given tag name and description options
+ */ 
 export function build(tagName: string, description: DescribeOptions): void {
   class CustomComponent extends HTMLElement {
       constructor() {

diff --git a/deno.json b/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@ra9/tan-compose",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "exports": "./mod.ts",
   "compilerOptions": {
     "strict": true,

diff --git a/describe.ts b/describe.ts
@@ -1,6 +1,8 @@
 import { DescribeOptions } from './types.ts';
 
-
+/**
+ * Describes a component with options
+ */
 export function describe(options: DescribeOptions): DescribeOptions {
   return {
     ...options,