did natspec for TokenBridgePauseManager (#379)

Consensys · Dec 4, 2024 · 7778380 · 7778380
1 parent 5fa9eb9
commit 7778380
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/contracts/contracts/lib/TokenBridgePauseManager.sol b/contracts/contracts/lib/TokenBridgePauseManager.sol
@@ -9,8 +9,15 @@ import { PauseManager } from "./PauseManager.sol";
  * @custom:security-contact [email protected]
  */
 abstract contract TokenBridgePauseManager is PauseManager {
+  /// @notice This is used to pause token bridging initiation.
   bytes32 public constant PAUSE_INITIATE_TOKEN_BRIDGING_ROLE = keccak256("PAUSE_INITIATE_TOKEN_BRIDGING_ROLE");
+
+  /// @notice This is used to unpause token bridging initiation.
   bytes32 public constant UNPAUSE_INITIATE_TOKEN_BRIDGING_ROLE = keccak256("UNPAUSE_INITIATE_TOKEN_BRIDGING_ROLE");
+
+  /// @notice This is used to pause token bridging completion.
   bytes32 public constant PAUSE_COMPLETE_TOKEN_BRIDGING_ROLE = keccak256("PAUSE_COMPLETE_TOKEN_BRIDGING_ROLE");
+
+  /// @notice This is used to unpause token bridging completion.
   bytes32 public constant UNPAUSE_COMPLETE_TOKEN_BRIDGING_ROLE = keccak256("UNPAUSE_COMPLETE_TOKEN_BRIDGING_ROLE");
 }
diff --git a/contracts/docs/api/lib/TokenBridgePauseManager.md b/contracts/docs/api/lib/TokenBridgePauseManager.md
@@ -8,21 +8,29 @@
 bytes32 PAUSE_INITIATE_TOKEN_BRIDGING_ROLE
 ```
 
+This is used to pause token bridging initiation.
+
 ### UNPAUSE_INITIATE_TOKEN_BRIDGING_ROLE
 
 ```solidity
 bytes32 UNPAUSE_INITIATE_TOKEN_BRIDGING_ROLE
 ```
 
+This is used to unpause token bridging initiation.
+
 ### PAUSE_COMPLETE_TOKEN_BRIDGING_ROLE
 
 ```solidity
 bytes32 PAUSE_COMPLETE_TOKEN_BRIDGING_ROLE
 ```
 
+This is used to pause token bridging completion.
+
 ### UNPAUSE_COMPLETE_TOKEN_BRIDGING_ROLE
 
 ```solidity
 bytes32 UNPAUSE_COMPLETE_TOKEN_BRIDGING_ROLE
 ```
 
+This is used to unpause token bridging completion.
+