add docstrings for events in BlacklistableV1

trillion-network · Jan 23, 2024 · e696688 · e696688
1 parent b4c6365
commit e696688
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/v1/BlacklistableV1.sol b/src/v1/BlacklistableV1.sol
@@ -16,7 +16,16 @@ error CallerBlacklisted(address account);
 abstract contract BlacklistableV1 is Initializable, ContextUpgradeable, ERC20Upgradeable {
     mapping(address accountAddress => bool blacklisted) internal _blacklisted;
 
+    /**
+     * @dev Blacklisted event
+     * @param account The address that was blacklisted
+     */
     event Blacklisted(address indexed account);
+
+    /**
+     * @dev UnBlacklisted event
+     * @param account The address that was unblacklisted
+     */
     event UnBlacklisted(address indexed account);
 
     /**