diff --git a/examples/contracts/Bar.sol b/examples/contracts/Bar.sol index 6cc90ba..391155c 100644 --- a/examples/contracts/Bar.sol +++ b/examples/contracts/Bar.sol @@ -40,7 +40,8 @@ contract Bar is IBar { function set(T memory t) external { } /// @notice Cool function bro - /// @custom:requirement Check this requirement + /// @custom:requirement Check first requirement + /// @custom:requirement Check second requirement function boop(uint256 bar) external { } /// @notice Alt cool function bro diff --git a/examples/docs/Bar.json b/examples/docs/Bar.json index 7afa5d5..186aaf5 100644 --- a/examples/docs/Bar.json +++ b/examples/docs/Bar.json @@ -25,7 +25,8 @@ } }, "outputs": {}, - "notice": "Cool function bro" + "notice": "Cool function bro", + "custom:requirement": "Check first requirementCheck second requirement" }, "boop(uint256,uint256)": { "stateMutability": "nonpayable", diff --git a/examples/docs/Bar.md b/examples/docs/Bar.md index b63313d..7ac1bfd 100644 --- a/examples/docs/Bar.md +++ b/examples/docs/Bar.md @@ -37,7 +37,7 @@ function boop(uint256 bar) external nonpayable Cool function bro - +**Requirement:** *Check first requirementCheck second requirement* diff --git a/examples/docs/IBar.json b/examples/docs/IBar.json index bafc5e1..f73734f 100644 --- a/examples/docs/IBar.json +++ b/examples/docs/IBar.json @@ -32,7 +32,8 @@ } }, "notice": "Emitted when transfer", - "details": "Transfer some stuff" + "details": "Transfer some stuff", + "custom:danger": "This event exposes private info" } }, "errors": { diff --git a/examples/docs/IBar.md b/examples/docs/IBar.md index 6c9c019..5ab5687 100644 --- a/examples/docs/IBar.md +++ b/examples/docs/IBar.md @@ -59,7 +59,7 @@ event Transfer(uint256 foo) Emitted when transfer *Transfer some stuff* - +**Danger:** *This event exposes private info* #### Parameters