feat: add enhanced NatSpec for event type constants

Author: zeluisping

packages/ucef/contracts/UCEF.sol

@@ -42,7 +42,21 @@ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
  */
 abstract contract UCEF is ERC20 {
     // Event type constants for Private Events
+    /**
+    * @notice Transfer event parameter mapping:
+    *   - address param0: from  - Token sender (address(0) for minting)
+    *   - address param1: to    - Token receiver (address(0) for burning)
+    *   - uint256 param2: value - Amount of tokens transferred
+    * @custom:signature Transfer(address from, address to, uint256 value)
+    */
     bytes32 public constant EVENT_TYPE_TRANSFER = keccak256("Transfer(address,address,uint256)");
+    /**
+    * @notice Approval event parameter mapping:
+    *   - address param0: from  - Token sender (address(0) for minting)
+    *   - address param1: to    - Token receiver (address(0) for burning)
+    *   - uint256 param2: value - Amount of tokens approved
+    * @custom:signature Approval(address from, address to, uint256 value)
+    */
     bytes32 public constant EVENT_TYPE_APPROVAL = keccak256("Approval(address,address,uint256)");
 
     mapping(address account => uint256) private _balances;

packages/ucef/contracts/UCEFRegulated.sol

@@ -31,6 +31,12 @@ import {UCEF} from "./UCEF.sol";
  */
 contract UCEFRegulated is UCEF {
     // Event type constant for Private Events
+    /**
+    * @notice RegulatorUpdated event parameter mapping:
+    *   - address param0: previousRegulator - Address of the previous regulator
+    *   - address param1: newRegulator      - Address of the new regulator
+    * @custom:signature RegulatorUpdated(address previousRegulator, address newRegulator)
+    */
     bytes32 public constant EVENT_TYPE_REGULATOR_UPDATED = keccak256("RegulatorUpdated(address,address)");
 
     address private _regulator;

packages/ucef/contracts/UCEFSharable.sol

@@ -34,7 +34,20 @@ import {UCEF} from "./UCEF.sol";
  */
 contract UCEFSharable is UCEF {
     // Event type constants for Private Events
+    /**
+    * @notice ViewerPermissionUpdated event parameter mapping:
+    *   - address param0: account - The account whose balance viewing permissions were modified
+    *   - address param1: viewer  - The address that was granted or revoked viewing permission
+    *   - bool param2: status     - The new permission status (true for granted, false for revoked)
+    * @custom:signature ViewerPermissionUpdated(address account, address viewer, bool status)
+    */
     bytes32 public constant EVENT_TYPE_VIEWER_PERMISSION_UPDATED = keccak256("ViewerPermissionUpdated(address,address,bool)");
+    /**
+    * @notice SupervisorUpdated event parameter mapping:
+    *   - address param0: previousSupervisor - Address of the previous supervisor
+    *   - address param1: newSupervisor      - Address of the new supervisor (zero address means supervision permanently disabled)
+    * @custom:signature SupervisorUpdated(address previousSupervisor, address newSupervisor)
+    */
     bytes32 public constant EVENT_TYPE_SUPERVISOR_UPDATED = keccak256("SupervisorUpdated(address,address)");
 
     // Mapping from account address to viewer address to permission status