Inheritdoc fix (#26)

* fix variable declaration inheritdoc and add support for multiple dev comments

* add limitation and update patch version

Author: mllwchrry

README.md

@@ -236,3 +236,4 @@ contract Example {
 ## Known limitations
 
 - `Vyper` is currently not supported.
+- `inheritdoc` parsing is ignored for state variable declarations.

package-lock.json

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

package.json

@@ -65,7 +65,7 @@ export class MDGenerator {
     }
 
     if (documentation.dev) {
-      res.push(documentation.dev);
+      res.push(...documentation.dev);
     }
 
     if (documentation.custom) {

src/generator/md-generator/MDGenerator.ts

@@ -486,9 +486,11 @@ export class Parser {
             }
             case "dev": {
               if (!natSpec.dev) {
-                natSpec.dev = text;
+                natSpec.dev = [];
               }
 
+              natSpec.dev.push(text);
+
               break;
             }
             case "param": {
@@ -588,6 +590,8 @@ export class Parser {
                 parentNode = this.findFunctionDefinitionByContractName(node, parentName);
               } else if (node.nodeType === "ModifierDefinition") {
                 parentNode = this.findModifierDefinitionByContractName(node, parentName);
+              } else if (node.nodeType === "VariableDeclaration") {
+                break;
               }
 
               if (!parentNode) {

src/parser/Parser.ts

@@ -21,7 +21,7 @@ export interface NatSpecDocumentation {
   title?: string;
   author?: string;
   notice?: string;
-  dev?: string;
+  dev?: string[];
   params?: {
     name?: string;
     type?: string;