add docgen

crapthings · Apr 28, 2022 · c363e4a · c363e4a
1 parent a07e3ad
commit c363e4a
Show file tree

Hide file tree

Showing 7 changed files with 2,060 additions and 931 deletions.
diff --git a/dapp-contract/contracts/Dapp.sol b/dapp-contract/contracts/Dapp.sol
@@ -4,18 +4,22 @@ pragma solidity ^0.8.9;
 import "hardhat/console.sol";
 
 contract Dapp {
-  string private str = 'Hardhat Parcel Dapp Starter';
+  string private _str = 'Hardhat Parcel Dapp Starter';
 
   event changeStr(string str);
 
+  /// @notice use this function to view your string
+  /// @return str
   function getStr () public view returns (string memory) {
-    console.log("log: str is equal to", str);
-    return str;
+    console.log("log: str is equal to", _str);
+    return _str;
   }
 
-  function setStr (string memory _str) public {
-    console.log("log: set str to", _str);
-    str = _str;
-    emit changeStr(str);
+  /// @notice set string to your input
+  /// @param str set string to any thing that fit your need
+  function setStr (string memory str) public {
+    console.log("log: set str to", str);
+    _str = str;
+    emit changeStr(_str);
   }
 }
diff --git a/dapp-contract/docs/index.html b/dapp-contract/docs/index.html
@@ -0,0 +1 @@
+<!doctype html><html lang="en"><head><meta charset="utf-8"><title>Hardhat Docgen</title><link href="https://unpkg.com/tailwindcss@^2/dist/tailwind.min.css" rel="stylesheet"><script defer="defer" src="main.js"></script></head><body><div id="app"></div></body></html>
diff --git a/dapp-contract/docs/main.js b/dapp-contract/docs/main.js
diff --git a/dapp-contract/docs/main.js.LICENSE.txt b/dapp-contract/docs/main.js.LICENSE.txt
@@ -0,0 +1,5 @@
+/*!
+ * Vue.js v2.6.14
+ * (c) 2014-2021 Evan You
+ * Released under the MIT License.
+ */
diff --git a/hardhat.config.js b/hardhat.config.js
@@ -1,6 +1,7 @@
 require('@nomiclabs/hardhat-waffle')
 require('solidity-coverage')
 require('hardhat-gas-reporter')
+require('hardhat-docgen')
 
 module.exports = {
   solidity: '0.8.9',
@@ -14,5 +15,10 @@ module.exports = {
     hardhat: {
       chainId: 1337
     },
+  },
+  docgen: {
+    path: './docs',
+    clear: true,
+    runOnCompile: true,
   }
 }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<!doctype html><html lang="en"><head><meta charset="utf-8"><title>Hardhat Docgen</title><link href="https://unpkg.com/tailwindcss@^2/dist/tailwind.min.css" rel="stylesheet"><script defer="defer" src="main.js"></script></head><body><div id="app"></div></body></html>