refactor: update precompiles

test: update formatting in comments
sablier-labs · Apr 12, 2024 · f5f7492 · f5f7492
1 parent 079f432
commit f5f7492
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 21 deletions.
diff --git a/precompiles/Precompiles.sol b/precompiles/Precompiles.sol
diff --git a/test/utils/BatchLockupBuilder.sol b/test/utils/BatchLockupBuilder.sol
@@ -21,7 +21,7 @@ library BatchLockupBuilder {
         }
     }
 
-    /// @notice Turns the `params` into an array of `BatchLockup.CreateWithDurationsLD` structs.
+    /// @notice Turns the `params` into an array of {BatchLockup.CreateWithDurationsLD} structs.
     function fillBatch(
         LockupDynamic.CreateWithDurations memory params,
         uint256 batchSize
@@ -58,7 +58,7 @@ library BatchLockupBuilder {
         }
     }
 
-    /// @notice Turns the `params` into an array of `BatchLockup.CreateWithDurationsLL` structs.
+    /// @notice Turns the `params` into an array of {BatchLockup.CreateWithDurationsLL} structs.
     function fillBatch(
         LockupLinear.CreateWithDurations memory params,
         uint256 batchSize
@@ -95,7 +95,7 @@ library BatchLockupBuilder {
         }
     }
 
-    /// @notice Turns the `params` into an array of `BatchLockup.CreateWithDurationsLT` structs.
+    /// @notice Turns the `params` into an array of {BatchLockup.CreateWithDurationsLT} structs.
     function fillBatch(
         LockupTranched.CreateWithDurations memory params,
         uint256 batchSize
@@ -132,7 +132,7 @@ library BatchLockupBuilder {
         }
     }
 
-    /// @notice Turns the `params` into an array of `BatchLockup.CreateWithTimestampsLDs` structs.
+    /// @notice Turns the `params` into an array of {BatchLockup.CreateWithTimestampsLDs} structs.
     function fillBatch(
         LockupDynamic.CreateWithTimestamps memory params,
         uint256 batchSize
@@ -170,7 +170,7 @@ library BatchLockupBuilder {
         }
     }
 
-    /// @notice Turns the `params` into an array of `BatchLockup.CreateWithTimestampsLL` structs.
+    /// @notice Turns the `params` into an array of {BatchLockup.CreateWithTimestampsLL} structs.
     function fillBatch(
         LockupLinear.CreateWithTimestamps memory params,
         uint256 batchSize
@@ -207,7 +207,7 @@ library BatchLockupBuilder {
         }
     }
 
-    /// @notice Turns the `params` into an array of `BatchLockup.CreateWithTimestampsLT` structs.
+    /// @notice Turns the `params` into an array of {BatchLockup.CreateWithTimestampsLT} structs.
     function fillBatch(
         LockupTranched.CreateWithTimestamps memory params,
         uint256 batchSize

diff --git a/test/utils/Defaults.sol b/test/utils/Defaults.sol
@@ -212,7 +212,7 @@ contract Defaults is Merkle {
         });
     }
 
-    /// @dev Returns a batch of `LockupDynamic.Segment` parameters.
+    /// @dev Returns a batch of `LockupDynamic.Segment} parameters.
     function segments() private view returns (LockupDynamic.Segment[] memory segments_) {
         segments_ = new LockupDynamic.Segment[](2);
         segments_[0] = LockupDynamic.Segment({
@@ -227,12 +227,12 @@ contract Defaults is Merkle {
         });
     }
 
-    /// @dev Returns a batch of `LockupDynamic.SegmentWithDuration` parameters.
+    /// @dev Returns a batch of `LockupDynamic.SegmentWithDuration} parameters.
     function segmentsWithDurations() public pure returns (LockupDynamic.SegmentWithDuration[] memory) {
         return segmentsWithDurations({ amount0: 2500e18, amount1: 7500e18 });
     }
 
-    /// @dev Returns a batch of `LockupDynamic.SegmentWithDuration` parameters.
+    /// @dev Returns a batch of `LockupDynamic.SegmentWithDuration} parameters.
     function segmentsWithDurations(
         uint128 amount0,
         uint128 amount1
@@ -356,12 +356,12 @@ contract Defaults is Merkle {
         }
     }
 
-    /// @dev Returns a batch of `LockupTranched.TrancheWithDuration` parameters.
+    /// @dev Returns a batch of `LockupTranched.TrancheWithDuration} parameters.
     function tranchesWithDurations() public pure returns (LockupTranched.TrancheWithDuration[] memory) {
         return tranchesWithDurations({ amount0: 2500e18, amount1: 7500e18 });
     }
 
-    /// @dev Returns a batch of `LockupTranched.TrancheWithDuration` parameters.
+    /// @dev Returns a batch of `LockupTranched.TrancheWithDuration} parameters.
     function tranchesWithDurations(
         uint128 amount0,
         uint128 amount1
@@ -379,27 +379,27 @@ contract Defaults is Merkle {
                                     BATCH-LOCKUP
     //////////////////////////////////////////////////////////////////////////*/
 
-    /// @dev Returns a default-size batch of `BatchLockup.CreateWithDurationsLD` parameters.
+    /// @dev Returns a default-size batch of {BatchLockup.CreateWithDurationsLD} parameters.
     function batchCreateWithDurationsLD() public view returns (BatchLockup.CreateWithDurationsLD[] memory batch) {
         batch = BatchLockupBuilder.fillBatch(createWithDurationsLD(), BATCH_SIZE);
     }
 
-    /// @dev Returns a default-size batch of `BatchLockup.CreateWithDurationsLL` parameters.
+    /// @dev Returns a default-size batch of {BatchLockup.CreateWithDurationsLL} parameters.
     function batchCreateWithDurationsLL() public view returns (BatchLockup.CreateWithDurationsLL[] memory batch) {
         batch = BatchLockupBuilder.fillBatch(createWithDurationsLL(), BATCH_SIZE);
     }
 
-    /// @dev Returns a default-size batch of `BatchLockup.CreateWithDurationsLT` parameters.
+    /// @dev Returns a default-size batch of {BatchLockup.CreateWithDurationsLT} parameters.
     function batchCreateWithDurationsLT() public view returns (BatchLockup.CreateWithDurationsLT[] memory batch) {
         batch = BatchLockupBuilder.fillBatch(createWithDurationsLT(), BATCH_SIZE);
     }
 
-    /// @dev Returns a default-size batch of `BatchLockup.CreateWithTimestampsLD` parameters.
+    /// @dev Returns a default-size batch of {BatchLockup.CreateWithTimestampsLD} parameters.
     function batchCreateWithTimestampsLD() public view returns (BatchLockup.CreateWithTimestampsLD[] memory batch) {
         batch = batchCreateWithTimestampsLD(BATCH_SIZE);
     }
 
-    /// @dev Returns a batch of `BatchLockup.CreateWithTimestampsLD` parameters.
+    /// @dev Returns a batch of {BatchLockup.CreateWithTimestampsLD} parameters.
     function batchCreateWithTimestampsLD(uint256 batchSize)
         public
         view
@@ -408,12 +408,12 @@ contract Defaults is Merkle {
         batch = BatchLockupBuilder.fillBatch(createWithTimestampsLD(), batchSize);
     }
 
-    /// @dev Returns a default-size batch of `BatchLockup.CreateWithTimestampsLL` parameters.
+    /// @dev Returns a default-size batch of {BatchLockup.CreateWithTimestampsLL} parameters.
     function batchCreateWithTimestampsLL() public view returns (BatchLockup.CreateWithTimestampsLL[] memory batch) {
         batch = batchCreateWithTimestampsLL(BATCH_SIZE);
     }
 
-    /// @dev Returns a batch of `BatchLockup.CreateWithTimestampsLL` parameters.
+    /// @dev Returns a batch of {BatchLockup.CreateWithTimestampsLL} parameters.
     function batchCreateWithTimestampsLL(uint256 batchSize)
         public
         view
@@ -422,12 +422,12 @@ contract Defaults is Merkle {
         batch = BatchLockupBuilder.fillBatch(createWithTimestampsLL(), batchSize);
     }
 
-    /// @dev Returns a default-size batch of `BatchLockup.CreateWithTimestampsLT` parameters.
+    /// @dev Returns a default-size batch of {BatchLockup.CreateWithTimestampsLT} parameters.
     function batchCreateWithTimestampsLT() public view returns (BatchLockup.CreateWithTimestampsLT[] memory batch) {
         batch = batchCreateWithTimestampsLT(BATCH_SIZE);
     }
 
-    /// @dev Returns a batch of `BatchLockup.CreateWithTimestampsLL` parameters.
+    /// @dev Returns a batch of {BatchLockup.CreateWithTimestampsLL} parameters.
     function batchCreateWithTimestampsLT(uint256 batchSize)
         public
         view