From c20e620a06da6ead44e8b85601ad7decc5180e2a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20Venturo?= Date: Mon, 4 May 2020 16:36:04 -0300 Subject: [PATCH] Improve Pausable docs --- contracts/utils/Pausable.sol | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/contracts/utils/Pausable.sol b/contracts/utils/Pausable.sol index 71301d6de..f9da9c73d 100644 --- a/contracts/utils/Pausable.sol +++ b/contracts/utils/Pausable.sol @@ -40,6 +40,10 @@ contract Pausable is Context { /** * @dev Modifier to make a function callable only when the contract is not paused. + * + * Requirements: + * + * - The contract must not be paused. */ modifier whenNotPaused() { require(!_paused, "Pausable: paused"); @@ -48,6 +52,10 @@ contract Pausable is Context { /** * @dev Modifier to make a function callable only when the contract is paused. + * + * Requirements: + * + * - The contract must be paused. */ modifier whenPaused() { require(_paused, "Pausable: not paused"); @@ -56,6 +64,10 @@ contract Pausable is Context { /** * @dev Triggers stopped state. + * + * Requirements: + * + * - The contract must not be paused. */ function _pause() internal virtual whenNotPaused { _paused = true; @@ -64,6 +76,10 @@ contract Pausable is Context { /** * @dev Returns to normal state. + * + * Requirements: + * + * - The contract must be paused. */ function _unpause() internal virtual whenPaused { _paused = false;