Merge pull request #56 from nikeee/tsdoc

kaelzhang · web-flow · commit 655539ead88d · 2025-09-29T09:24:57.000+08:00
Use JSDoc for type comments where possible
diff --git a/index.d.ts b/index.d.ts
@@ -37,18 +37,19 @@ export interface CommentObject {
 
 export interface CommentToken {
   type: 'BlockComment' | 'LineComment'
-  // The content of the comment, including whitespaces and line breaks
+  /** The content of the comment, including whitespaces and line breaks */
   value: string
-  // If the start location is the same line as the previous token,
-  // then `inline` is `true`
+  /**
+   * If the start location is the same line as the previous token,
+   * then `inline` is `true`
+   */
   inline: boolean
-  // But pay attention that,
-  // locations will NOT be maintained when stringified
+  /* But pay attention that, locations will NOT be maintained when stringified */
   loc: CommentLocation
 }
 
 export interface CommentLocation {
-  // The start location begins at the `//` or `/*` symbol
+  /** The start location begins at the `//` or `/*` symbol */
   start: Location
   // The end location of multi-line comment ends at the `*/` symbol
   end: Location
