Feat/correction of invalid tag (#23)

* Added autocorrecting an invalid '@param' tag to a valid '@return' one

* Bumped version

* Added second loop iteration for invalid tags

Author: RuslanProgrammer

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solarity/hardhat-markup",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Customizable markdown smart contracts documentation",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",

src/parser/Parser.ts

@@ -434,8 +434,10 @@ export class Parser {
 
         const natSpecRegex = /^(?:@(\w+|custom:[a-z][a-z-]*) )?((?:(?!^@(?:\w+|custom:[a-z][a-z-]*) )[^])*)/gm;
 
-        for (const match of text.matchAll(natSpecRegex)) {
-          const [, tag = "notice", rawText] = match;
+        const matches = [...text.matchAll(natSpecRegex)];
+
+        for (let i = 0; i < matches.length; i++) {
+          const [, tag = "notice", rawText] = matches[i];
           const text = this.replaceMultipleNewLinesWithOne(rawText);
 
           switch (tag) {
@@ -484,8 +486,14 @@ export class Parser {
 
               const variableDeclaration = params.find((param) => param.name == paramName);
 
+              // so that tag was not found, and it may be a return tag
               if (!variableDeclaration) {
-                throw new Error(`Invalid param name: ${paramName}`);
+                // protection from infinite loop
+                if (node.nodeType !== "EventDefinition") {
+                  matches[i][1] = "return";
+                  i--;
+                }
+                break;
               }
 
               const type = variableDeclaration.typeDescriptions?.typeString || undefined;
@@ -495,6 +503,13 @@ export class Parser {
               break;
             }
             case "return": {
+              // there is no return tag in events, so it is a param tag
+              if (node.nodeType === "EventDefinition") {
+                matches[i][1] = "param";
+                i--;
+                break;
+              }
+
               natSpec.returns ??= [];
 
               let currentParameter: VariableDeclaration = isNodeType("FunctionDefinition", node)