Update event dev docs combining

b00ste · Jul 10, 2023 · 30b31d6 · 30b31d6
1 parent b96dc0f
commit 30b31d6
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 26 deletions.
diff --git a/examples/docs/contracts/Bar.json b/examples/docs/contracts/Bar.json
@@ -119,8 +119,7 @@
                 }
             },
             "notice": "Emitted when transfer",
-            "details": "Transfer some stuff",
-            "custom:danger": "This event exposes private info"
+            "details": "Transfer some stuff"
         }
     },
     "errors": {

diff --git a/examples/docs/contracts/Bar.md b/examples/docs/contracts/Bar.md
@@ -172,7 +172,7 @@ event Transfer(uint256 foo)
 Emitted when transfer
 *Transfer some stuff*
 
-**Danger:** *This event exposes private info*
+
 
 
 #### Parameters

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@b00ste/hardhat-dodoc",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "Zero-config Hardhat plugin to generate documentation for all your Solidity contracts",
   "repository": "github:b00ste/primitive-dodoc",
   "author": "Primitive",

diff --git a/src/index.ts b/src/index.ts
@@ -48,28 +48,6 @@ async function generateDocumentation(hre: HardhatRuntimeEnvironment): Promise<vo
     const buildInfo = await hre.artifacts.getBuildInfo(qualifiedName);
     const info = buildInfo?.output.contracts[source][name] as CompilerOutputContractWithDocumentation;
 
-    // Getting inheritance of the contract and combining the natspec
-    for (const inheritanceSource in buildInfo?.output.contracts) {
-      const fileContracts = buildInfo?.output.contracts[inheritanceSource];
-      for (const inheritanceContract in fileContracts) {
-        const contractBuildInfo = fileContracts[
-          inheritanceContract
-        ] as CompilerOutputContractWithDocumentation;
-        // Combining devdoc
-        const contractDevdoc = info.devdoc;
-        const parentContractDevdoc = contractBuildInfo.devdoc;
-        if (parentContractDevdoc !== undefined) {
-          if (contractDevdoc !== undefined) {
-            contractDevdoc.events = {
-              ...contractDevdoc.events,
-              ...parentContractDevdoc.events,
-            };
-          }
-          info.devdoc = contractDevdoc;
-        }
-      }
-    }
-
     if (config.debugMode) {
       console.log('ABI:\n');
       console.log(JSON.stringify(info.abi, null, 4));
@@ -417,6 +395,50 @@ async function generateDocumentation(hre: HardhatRuntimeEnvironment): Promise<vo
       }
     }
 
+    // console.log(doc.events);
+    // Getting inheritance of the contract and combining the natspec
+    for (const inheritanceSource in buildInfo?.output.contracts) {
+      const fileContracts = buildInfo?.output.contracts[inheritanceSource];
+      for (const inheritanceContract in fileContracts) {
+        const contractBuildInfo = fileContracts[
+          inheritanceContract
+        ] as CompilerOutputContractWithDocumentation;
+        // Combining devdoc
+        const parentContractDevdocEvents = contractBuildInfo.devdoc?.events;
+        if (parentContractDevdocEvents) {
+          if (doc) {
+            if (doc.events) {
+              for (const event in doc.events) {
+                let eventSignatrue = `${event}(`;
+                if (doc.events[event].inputs) {
+                  for (const input in doc.events[event].inputs) {
+                    eventSignatrue += `${doc.events[event].inputs[input].type},`;
+                  }
+                  eventSignatrue = eventSignatrue.substring(0, eventSignatrue.length - 1);
+                }
+                eventSignatrue += ')';
+
+                if (doc.events[event] && parentContractDevdocEvents[eventSignatrue]) {
+                  if (doc.events[event].details === undefined) {
+                    if (parentContractDevdocEvents[eventSignatrue].details) {
+                      doc.events[event].details = parentContractDevdocEvents[eventSignatrue].details;
+                    }
+                    if (parentContractDevdocEvents[eventSignatrue].params) {
+                      for (const param in parentContractDevdocEvents[eventSignatrue].params) {
+                        doc.events[event].inputs[param].description =
+                          parentContractDevdocEvents[eventSignatrue].params[param];
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+    // console.log(doc.events);
+
     doc.name = name;
     docs.push(doc);
   }