Add support for macro doc comments

Author: object-Object

CHANGELOG.md

@@ -35,6 +35,14 @@ vscode-hex-casting now supports Hex Casting 0.11.2 for Minecraft 1.20.1! This is
     "hex-casting.disabledModIds": ["hexal", "moreiotas"]
   }
   ```
+- Added support for setting the description of macros. Any lines starting with `///` immediately after the macro definition will be included as Markdown. For example:
+  ```
+  #define My Macro (EAST aqweds) = int -> str
+  /// **Description line 1.**
+  /// More text on description line 1.
+  ///
+  /// Description line 2.
+  ```
 
 ### Changes
 

src/extension.ts

@@ -962,10 +962,18 @@ async function refreshDirectivesAndDiagnostics(
             return;
         }
 
+        let descriptionLines = [];
+        for (let i = lineIndex + 1; i < document.lineCount; i++) {
+            const line = document.lineAt(i).text.trim();
+            if (!line.startsWith("///")) break;
+            descriptionLines.push(line.slice(3).trimStart());
+        }
+
         newMacroRegistryWithImports[translation] = newMacroRegistry[translation] = new MacroPatternInfo({
             translation,
             direction,
             signature,
+            description: descriptionLines.join("\n") || undefined,
             inputs,
             outputs,
         });

src/patterns/types.ts

@@ -89,12 +89,14 @@ export class MacroPatternInfo {
         translation,
         direction,
         signature,
+        description,
         inputs,
         outputs,
     }: {
         translation: string;
         direction?: Direction;
         signature?: string;
+        description?: string;
         inputs?: string;
         outputs?: string;
     }) {
@@ -103,7 +105,7 @@ export class MacroPatternInfo {
         this.signature = signature ?? null;
         this.operators = [
             {
-                description: null,
+                description: description ?? null,
                 inputs: inputs ?? null,
                 outputs: outputs ?? null,
                 book_url: null,

test.hexpattern

@@ -7,6 +7,10 @@ Imported
 #define Foo's Reflection = int ->[str]*/
 #define (e) = int->[str]
 #define Foo's Reflection (northeast aqweds) = int->[str] //
+/// **Description line 1.**
+/// More text on description line 1.
+///
+/// Description line 2.
 #define Foo's Reflection1 (nse aaa) = int ->[str]
 #define Foo's Reflection2 (w) = int -> [str]
 #define Foo's Reflection3 (se d) = int -> 
@@ -24,6 +28,8 @@ Imported
 #define Foo's Purification3 (e)
 #define Foo's Purification4 (e) =     
 #define Foo's Reflection12
+/// description line 1
+/// description line 2
 #define Foo's Reflection13 = int -> int
  #define Foo =
  define Foo