Ver Fonte

Fix broken crossreference links (#2005)

* Bump solidity-docgen from 0.3.11 to 0.3.13

Bumps solidity-docgen from 0.3.11 to 0.3.13.

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* fix broken crossreference links
Francisco Giordano há 5 anos atrás
pai
commit
8e980480aa

+ 1 - 1
contracts/GSN/GSNRecipient.sol

@@ -8,7 +8,7 @@ import "./Context.sol";
  * @dev Base GSN recipient contract: includes the {IRelayRecipient} interface
  * and enables GSN support on all contracts in the inheritance tree.
  *
- * TIP: This contract is abstract. The functions {acceptRelayedCall},
+ * TIP: This contract is abstract. The functions {IRelayRecipient-acceptRelayedCall},
  *  {_preRelayedCall}, and {_postRelayedCall} are not implemented and must be
  * provided by derived contracts. See the
  * xref:ROOT:gsn-strategies.adoc#gsn-strategies[GSN strategies] for more

+ 5 - 0
contracts/lifecycle/README.adoc

@@ -0,0 +1,5 @@
+= Lifecycle
+
+== Pausable
+
+{{Pausable}}

+ 6 - 6
contracts/token/ERC777/ERC777.sol

@@ -132,7 +132,7 @@ contract ERC777 is Context, IERC777, IERC20 {
     /**
      * @dev See {IERC777-send}.
      *
-     * Also emits a {Transfer} event for ERC20 compatibility.
+     * Also emits a {IERC20-Transfer} event for ERC20 compatibility.
      */
     function send(address recipient, uint256 amount, bytes calldata data) external {
         _send(_msgSender(), _msgSender(), recipient, amount, data, "", true);
@@ -163,7 +163,7 @@ contract ERC777 is Context, IERC777, IERC20 {
     /**
      * @dev See {IERC777-burn}.
      *
-     * Also emits a {Transfer} event for ERC20 compatibility.
+     * Also emits a {IERC20-Transfer} event for ERC20 compatibility.
      */
     function burn(uint256 amount, bytes calldata data) external {
         _burn(_msgSender(), _msgSender(), amount, data, "");
@@ -221,7 +221,7 @@ contract ERC777 is Context, IERC777, IERC20 {
     /**
      * @dev See {IERC777-operatorSend}.
      *
-     * Emits {Sent} and {Transfer} events.
+     * Emits {Sent} and {IERC20-Transfer} events.
      */
     function operatorSend(
         address sender,
@@ -239,7 +239,7 @@ contract ERC777 is Context, IERC777, IERC20 {
     /**
      * @dev See {IERC777-operatorBurn}.
      *
-     * Emits {Burned} and {Transfer} events.
+     * Emits {Burned} and {IERC20-Transfer} events.
      */
     function operatorBurn(address account, uint256 amount, bytes calldata data, bytes calldata operatorData) external {
         require(isOperatorFor(_msgSender(), account), "ERC777: caller is not an operator for holder");
@@ -275,7 +275,7 @@ contract ERC777 is Context, IERC777, IERC20 {
     * call `transferFrom` (unless they have allowance), and accounts with
     * allowance cannot call `operatorSend` (unless they are operators).
     *
-    * Emits {Sent}, {Transfer} and {Approval} events.
+    * Emits {Sent}, {IERC20-Transfer} and {IERC20-Approval} events.
     */
     function transferFrom(address holder, address recipient, uint256 amount) external returns (bool) {
         require(recipient != address(0), "ERC777: transfer to the zero address");
@@ -302,7 +302,7 @@ contract ERC777 is Context, IERC777, IERC20 {
      *
      * See {IERC777Sender} and {IERC777Recipient}.
      *
-     * Emits {Minted} and {Transfer} events.
+     * Emits {Minted} and {IERC20-Transfer} events.
      *
      * Requirements
      *

+ 3 - 3
docs/contract.hbs

@@ -22,7 +22,7 @@
 .{{contract.name}}
 {{/unless}}
 {{#each modifiers}}
-* xref:#{{anchor}}[`{{name}}({{args.names}})`]
+* {xref-{{slug fullName~}} }[`{{name}}({{args.names}})`]
 {{/each}}
 
 {{/each}}
@@ -39,7 +39,7 @@
 .{{contract.name}}
 {{/unless}}
 {{#each functions}}
-* xref:#{{anchor}}[`{{name}}({{args.names}})`]
+* {xref-{{slug fullName~}} }[`{{name}}({{args.names}})`]
 {{/each}}
 
 {{/each}}
@@ -56,7 +56,7 @@
 .{{contract.name}}
 {{/unless}}
 {{#each events}}
-* xref:#{{anchor}}[`{{name}}({{args.names}})`]
+* {xref-{{slug fullName~}} }[`{{name}}({{args.names}})`]
 {{/each}}
 
 {{/each}}

+ 1 - 0
docs/prelude.hbs

@@ -1,3 +1,4 @@
 {{#links}}
 :{{slug target.fullName}}: pass:normal[xref:{{path}}#{{target.anchor}}[`{{target.fullName}}`]]
+:xref-{{slug target.fullName}}: xref:{{path}}#{{target.anchor}}
 {{/links}}

+ 31 - 95
package-lock.json

@@ -9170,38 +9170,27 @@
       "dev": true
     },
     "solc": {
-      "version": "0.5.12",
-      "resolved": "https://registry.npmjs.org/solc/-/solc-0.5.12.tgz",
-      "integrity": "sha512-OX/AGZT04tuUsagoVXSZBiBZYJReA02hdwZOfRkB03/eeYP9Dl3pr+M+au+1MhssgiuWBlFPN7sRXFiqwkAW2g==",
+      "version": "0.5.13",
+      "resolved": "https://registry.npmjs.org/solc/-/solc-0.5.13.tgz",
+      "integrity": "sha512-osybDVPGjAqcmSKLU3vh5iHuxbhGlJjQI5ZvI7nRDR0fgblQqYte4MGvNjbew8DPvCrmoH0ZBiz/KBBLlPxfMg==",
       "dev": true,
       "requires": {
         "command-exists": "^1.2.8",
+        "commander": "3.0.2",
         "fs-extra": "^0.30.0",
         "js-sha3": "0.8.0",
         "memorystream": "^0.3.1",
         "require-from-string": "^2.0.0",
         "semver": "^5.5.0",
-        "tmp": "0.0.33",
-        "yargs": "^13.2.0"
+        "tmp": "0.0.33"
       },
       "dependencies": {
-        "ansi-regex": {
-          "version": "4.1.0",
-          "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz",
-          "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==",
+        "commander": {
+          "version": "3.0.2",
+          "resolved": "https://registry.npmjs.org/commander/-/commander-3.0.2.tgz",
+          "integrity": "sha512-Gar0ASD4BDyKC4hl4DwHqDrmvjoxWKZigVnAbn5H1owvm4CxCPdb0HQDehwNYMJpla5+M2tPmPARzhtYuwpHow==",
           "dev": true
         },
-        "cliui": {
-          "version": "5.0.0",
-          "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz",
-          "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==",
-          "dev": true,
-          "requires": {
-            "string-width": "^3.1.0",
-            "strip-ansi": "^5.2.0",
-            "wrap-ansi": "^5.1.0"
-          }
-        },
         "fs-extra": {
           "version": "0.30.0",
           "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-0.30.0.tgz",
@@ -9215,12 +9204,6 @@
             "rimraf": "^2.2.8"
           }
         },
-        "get-caller-file": {
-          "version": "2.0.5",
-          "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
-          "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==",
-          "dev": true
-        },
         "js-sha3": {
           "version": "0.8.0",
           "resolved": "https://registry.npmjs.org/js-sha3/-/js-sha3-0.8.0.tgz",
@@ -9236,76 +9219,11 @@
             "graceful-fs": "^4.1.6"
           }
         },
-        "require-main-filename": {
-          "version": "2.0.0",
-          "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-2.0.0.tgz",
-          "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==",
-          "dev": true
-        },
         "semver": {
           "version": "5.7.1",
           "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz",
           "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==",
           "dev": true
-        },
-        "string-width": {
-          "version": "3.1.0",
-          "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz",
-          "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==",
-          "dev": true,
-          "requires": {
-            "emoji-regex": "^7.0.1",
-            "is-fullwidth-code-point": "^2.0.0",
-            "strip-ansi": "^5.1.0"
-          }
-        },
-        "strip-ansi": {
-          "version": "5.2.0",
-          "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz",
-          "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==",
-          "dev": true,
-          "requires": {
-            "ansi-regex": "^4.1.0"
-          }
-        },
-        "wrap-ansi": {
-          "version": "5.1.0",
-          "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-5.1.0.tgz",
-          "integrity": "sha512-QC1/iN/2/RPVJ5jYK8BGttj5z83LmSKmvbvrXPNCLZSEb32KKVDJDl/MOt2N01qU2H/FkzEa9PKto1BqDjtd7Q==",
-          "dev": true,
-          "requires": {
-            "ansi-styles": "^3.2.0",
-            "string-width": "^3.0.0",
-            "strip-ansi": "^5.0.0"
-          }
-        },
-        "yargs": {
-          "version": "13.3.0",
-          "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.3.0.tgz",
-          "integrity": "sha512-2eehun/8ALW8TLoIl7MVaRUrg+yCnenu8B4kBlRxj3GJGDKU1Og7sMXPNm1BYyM1DOJmTZ4YeN/Nwxv+8XJsUA==",
-          "dev": true,
-          "requires": {
-            "cliui": "^5.0.0",
-            "find-up": "^3.0.0",
-            "get-caller-file": "^2.0.1",
-            "require-directory": "^2.1.1",
-            "require-main-filename": "^2.0.0",
-            "set-blocking": "^2.0.0",
-            "string-width": "^3.0.0",
-            "which-module": "^2.0.0",
-            "y18n": "^4.0.0",
-            "yargs-parser": "^13.1.1"
-          }
-        },
-        "yargs-parser": {
-          "version": "13.1.1",
-          "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.1.1.tgz",
-          "integrity": "sha512-oVAVsHz6uFrg3XQheFII8ESO2ssAf9luWuAd6Wexsu4F3OtIW0o8IribPXYrD4WC24LWtPrJlGy87y5udK+dxQ==",
-          "dev": true,
-          "requires": {
-            "camelcase": "^5.0.0",
-            "decamelize": "^1.2.0"
-          }
         }
       }
     },
@@ -9789,9 +9707,9 @@
       }
     },
     "solidity-docgen": {
-      "version": "0.3.11",
-      "resolved": "https://registry.npmjs.org/solidity-docgen/-/solidity-docgen-0.3.11.tgz",
-      "integrity": "sha512-hQ65+MIOExbAWVdUYNZT6BLg6X96wULn75CWR7+Xaom173Brx+7NLYYdDc/De9x9DL1HNDilhLghNFBSIYsTAQ==",
+      "version": "0.3.13",
+      "resolved": "https://registry.npmjs.org/solidity-docgen/-/solidity-docgen-0.3.13.tgz",
+      "integrity": "sha512-wOssWWFK/wBMaukLyypj2HYp2F8qvjmq1cJByJtHmcI6WfR2NMI4yEzVom2skmreirR2YBV4NHu7nVNGZ68yZA==",
       "dev": true,
       "requires": {
         "@oclif/command": "^1.5.19",
@@ -9800,7 +9718,7 @@
         "@oclif/plugin-help": "^2.2.1",
         "fs-extra": "^8.1.0",
         "globby": "^10.0.1",
-        "handlebars": "^4.4.0",
+        "handlebars": "^4.5.3",
         "json5": "^2.1.0",
         "lodash": "^4.17.15",
         "micromatch": "^4.0.2",
@@ -9809,6 +9727,18 @@
         "solc": "^0.5.12"
       },
       "dependencies": {
+        "handlebars": {
+          "version": "4.5.3",
+          "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.5.3.tgz",
+          "integrity": "sha512-3yPecJoJHK/4c6aZhSvxOyG4vJKDshV36VHp0iVCDVh7o9w2vwi3NSnL2MMPj3YdduqaBcu7cGbggJQM0br9xA==",
+          "dev": true,
+          "requires": {
+            "neo-async": "^2.6.0",
+            "optimist": "^0.6.1",
+            "source-map": "^0.6.1",
+            "uglify-js": "^3.1.4"
+          }
+        },
         "lodash": {
           "version": "4.17.15",
           "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
@@ -9820,6 +9750,12 @@
           "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz",
           "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==",
           "dev": true
+        },
+        "source-map": {
+          "version": "0.6.1",
+          "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
+          "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
+          "dev": true
         }
       }
     },

+ 1 - 1
package.json

@@ -65,7 +65,7 @@
     "nodemon": "^1.19.4",
     "solhint": "2.3.0",
     "solidity-coverage": "github:rotcivegaf/solidity-coverage#5875f5b7bc74d447f3312c9c0e9fc7814b482477",
-    "solidity-docgen": "^0.3.11",
+    "solidity-docgen": "^0.3.13",
     "truffle": "^5.0.44"
   }
 }