chore: revert doc changes

exp-table · May 22, 2024 · 605ee9c · 605ee9c
1 parent 278c268
commit 605ee9c
Showing 1 changed file with 10 additions and 17 deletions.
diff --git a/src/wormhole/automatic-relayer/WormholeHelper.sol b/src/wormhole/automatic-relayer/WormholeHelper.sol
@@ -28,26 +28,19 @@ interface IWormholeReceiver {
 /// @notice supports only automatic relayer (not specialized relayers)
 /// MORE INFO: https://docs.wormhole.com/wormhole/quick-start/cross-chain-dev/automatic-relayer
 contract WormholeHelper is Test {
-    /*///////////////////////////////////////////////////////////////
-                                CONSTANTS
-    //////////////////////////////////////////////////////////////*/
-
     /// @dev LogMessagePublished (index_topic_1 address sender, uint64 sequence, uint32 nonce, bytes payload, uint8 consistencyLevel)
     bytes32 constant MESSAGE_EVENT_SELECTOR = 0x6eb224fb001ed210e379b335e35efe88672a8ce935d981a6896b27ffdf52a3b2;
 
-    /*///////////////////////////////////////////////////////////////
-                            STATE VARIABLES
-    //////////////////////////////////////////////////////////////*/
     uint256[] public indicesCache;
 
-    /*///////////////////////////////////////////////////////////////
-                             EXTERNAL FUNCTIONS
-    //////////////////////////////////////////////////////////////*/
+    //////////////////////////////////////////////////////////////
+    //                  EXTERNAL FUNCTIONS                      //
+    //////////////////////////////////////////////////////////////
 
     /// @dev single dst x default event selector
     /// @param srcChainId represents the wormhole identifier of the source chain
     /// @param dstForkId represents the dst fork id to deliver the message
-    /// @param dstRelayer is wormhole's dst chain relayer
+    /// @param dstRelayer represents wormhole's dst chain relayer
     /// @param logs represents the logs after message dispatch on src chain
     function help(uint16 srcChainId, uint256 dstForkId, address dstRelayer, Vm.Log[] calldata logs) external {
         _help(srcChainId, dstForkId, address(0), dstRelayer, MESSAGE_EVENT_SELECTOR, logs);
@@ -56,7 +49,7 @@ contract WormholeHelper is Test {
     /// @dev single dst x user-specific event selector
     /// @param srcChainId represents the wormhole identifier of the source chain
     /// @param dstForkId represents the dst fork id to deliver the message
-    /// @param dstRelayer is wormhole's dst chain relayer
+    /// @param dstRelayer represents wormhole's dst chain relayer
     /// @param logs represents the logs after message dispatch on src chain
     function help(
         uint16 srcChainId,
@@ -71,7 +64,7 @@ contract WormholeHelper is Test {
     /// @dev multi dst x default event selector
     /// @param srcChainId represents the wormhole identifier of the source chain
     /// @param dstForkId represents the dst fork id to deliver the message
-    /// @param dstRelayer is wormhole's dst chain relayer
+    /// @param dstRelayer represents wormhole's dst chain relayer
     /// @param logs represents the logs after message dispatch on src chain
     function help(
         uint16 srcChainId,
@@ -92,7 +85,7 @@ contract WormholeHelper is Test {
     /// @dev multi dst x user-specific event selector
     /// @param srcChainId represents the wormhole identifier of the source chain
     /// @param dstForkId represents the dst fork id to deliver the message
-    /// @param dstRelayer is wormhole's dst chain relayer
+    /// @param dstRelayer represents wormhole's dst chain relayer
     /// @param logs represents the logs after message dispatch on src chain
     function help(
         uint16 srcChainId,
@@ -142,9 +135,9 @@ contract WormholeHelper is Test {
         return _findLogs(logs, MESSAGE_EVENT_SELECTOR, length);
     }
 
-    /*///////////////////////////////////////////////////////////////
-                        INTERNAL/HELPER FUNCTIONS
-    //////////////////////////////////////////////////////////////*/
+    //////////////////////////////////////////////////////////////
+    //                  INTERNAL FUNCTIONS                      //
+    //////////////////////////////////////////////////////////////
 
     struct LocalVars {
         uint256 prevForkId;