More styling fixes

packages/contracts-bedrock/contracts/test/ResourceMetering.t.sol

 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.15;
 
+// Testing utilities
 import { Test } from "forge-std/Test.sol";
-import { ResourceMetering } from "../L1/ResourceMetering.sol";
-import { Proxy } from "../universal/Proxy.sol";
+
+// Libraries
 import { Constants } from "../libraries/Constants.sol";
 
+// Target contract dependencies
+import { Proxy } from "../universal/Proxy.sol";
+
+// Target contract
+import { ResourceMetering } from "../L1/ResourceMetering.sol";
+
 contract MeterUser is ResourceMetering {
     ResourceMetering.ResourceConfig public innerConfig;
 
@@ -50,20 +57,20 @@ contract MeterUser is ResourceMetering {
     }
 }
 
-/**
- * @title ResourceConfig
- * @notice The tests are based on the default config values. It is expected that
- *         the config values used in these tests are ran in production.
- */
+/// @title ResourceMetering_Test
+/// @dev Tests are based on the default config values.
+///      It is expected that these config values are used in production.
 contract ResourceMetering_Test is Test {
     MeterUser internal meter;
     uint64 initialBlockNum;
 
+    /// @dev Sets up the test contract.
     function setUp() public {
         meter = new MeterUser();
         initialBlockNum = uint64(block.number);
     }
 
+    /// @dev Tests that the initial resource params are set correctly.
     function test_meter_initialResourceParams_succeeds() external {
         (uint128 prevBaseFee, uint64 prevBoughtGas, uint64 prevBlockNum) = meter.params();
         ResourceMetering.ResourceConfig memory rcfg = meter.resourceConfig();
@@ -73,6 +80,7 @@ contract ResourceMetering_Test is Test {
         assertEq(prevBlockNum, initialBlockNum);
     }
 
+    /// @dev Tests that updating the resource params to the same values works correctly.
     function test_meter_updateParamsNoChange_succeeds() external {
         meter.use(0); // equivalent to just updating the base fee and block number
         (uint128 prevBaseFee, uint64 prevBoughtGas, uint64 prevBlockNum) = meter.params();
@@ -84,6 +92,7 @@ contract ResourceMetering_Test is Test {
         assertEq(postBlockNum, prevBlockNum);
     }
 
+    /// @dev Tests that updating the initial block number sets the meter params correctly.
     function test_meter_updateOneEmptyBlock_succeeds() external {
         vm.roll(initialBlockNum + 1);
         meter.use(0);
@@ -94,6 +103,7 @@ contract ResourceMetering_Test is Test {
         assertEq(prevBlockNum, initialBlockNum + 1);
     }
 
+    /// @dev Tests that updating the initial block number sets the meter params correctly.
     function test_meter_updateTwoEmptyBlocks_succeeds() external {
         vm.roll(initialBlockNum + 2);
         meter.use(0);
@@ -104,6 +114,7 @@ contract ResourceMetering_Test is Test {
         assertEq(prevBlockNum, initialBlockNum + 2);
     }
 
+    /// @dev Tests that updating the initial block number sets the meter params correctly.
     function test_meter_updateTenEmptyBlocks_succeeds() external {
         vm.roll(initialBlockNum + 10);
         meter.use(0);
@@ -114,6 +125,7 @@ contract ResourceMetering_Test is Test {
         assertEq(prevBlockNum, initialBlockNum + 10);
     }
 
+    /// @dev Tests that updating the gas delta sets the meter params correctly.
     function test_meter_updateNoGasDelta_succeeds() external {
         ResourceMetering.ResourceConfig memory rcfg = meter.resourceConfig();
         uint256 target = uint256(rcfg.maxResourceLimit) / uint256(rcfg.elasticityMultiplier);
@@ -125,6 +137,7 @@ contract ResourceMetering_Test is Test {
         assertEq(prevBlockNum, initialBlockNum);
     }
 
+    /// @dev Tests that the meter params are set correctly for the maximum gas delta.
     function test_meter_useMax_succeeds() external {
         ResourceMetering.ResourceConfig memory rcfg = meter.resourceConfig();
         uint64 target = uint64(rcfg.maxResourceLimit) / uint64(rcfg.elasticityMultiplier);
@@ -141,15 +154,9 @@ contract ResourceMetering_Test is Test {
         assertEq(postBaseFee, 2125000000);
     }
 
-    /**
-     * @notice This tests that the metered modifier reverts if
-     *         the ResourceConfig baseFeeMaxChangeDenominator
-     *         is set to 1.
-     *         Since the metered modifier internally calls
-     *         solmate's powWad function, it will revert
-     *         with the error string "UNDEFINED" since the
-     *         first parameter will be computed as 0.
-     */
+    /// @dev Tests that the metered modifier reverts if the baseFeeMaxChangeDenominator is set to 1.
+    ///      Since the metered modifier internally calls solmate's powWad function, it will revert
+    ///      with the error string "UNDEFINED" since the first parameter will be computed as 0.
     function test_meter_denominatorEq1_reverts() external {
         ResourceMetering.ResourceConfig memory rcfg = meter.resourceConfig();
         uint64 target = uint64(rcfg.maxResourceLimit) / uint64(rcfg.elasticityMultiplier);
@@ -167,6 +174,7 @@ contract ResourceMetering_Test is Test {
         meter.use(0);
     }
 
+    /// @dev Tests that the metered modifier reverts if the value is greater than allowed.
     function test_meter_useMoreThanMax_reverts() external {
         ResourceMetering.ResourceConfig memory rcfg = meter.resourceConfig();
         uint64 target = uint64(rcfg.maxResourceLimit) / uint64(rcfg.elasticityMultiplier);
@@ -176,8 +184,7 @@ contract ResourceMetering_Test is Test {
         meter.use(target * elasticityMultiplier + 1);
     }
 
-    // Demonstrates that the resource metering arithmetic can tolerate very large gaps between
-    // deposits.
+    /// @dev Tests that resource metering can handle large gaps between deposits.
     function testFuzz_meter_largeBlockDiff_succeeds(uint64 _amount, uint256 _blockDiff) external {
         // This test fails if the following line is commented out.
         // At 12 seconds per block, this number is effectively unreachable.
@@ -193,11 +200,9 @@ contract ResourceMetering_Test is Test {
     }
 }
 
-/**
- * @title CustomMeterUser
- * @notice A simple wrapper around `ResourceMetering` that allows the initial
- *         params to be set in the constructor.
- */
+/// @title CustomMeterUser
+/// @notice A simple wrapper around `ResourceMetering` that allows the initial
+///         params to be set in the constructor.
 contract CustomMeterUser is ResourceMetering {
     uint256 public startGas;
     uint256 public endGas;
@@ -230,15 +235,13 @@ contract CustomMeterUser is ResourceMetering {
     }
 }
 
-/**
- * @title ArtifactResourceMetering_Test
- * @notice A table test that sets the state of the ResourceParams and then requests
- *         various amounts of gas. This test ensures that a wide range of values
- *         can safely be used with the `ResourceMetering` contract.
- *         It also writes a CSV file to disk that includes useful information
- *         about how much gas is used and how expensive it is in USD terms to
- *         purchase the deposit gas.
- */
+/// @title ArtifactResourceMetering_Test
+/// @notice A table test that sets the state of the ResourceParams and then requests
+///         various amounts of gas. This test ensures that a wide range of values
+///         can safely be used with the `ResourceMetering` contract.
+///         It also writes a CSV file to disk that includes useful information
+///         about how much gas is used and how expensive it is in USD terms to
+///         purchase the deposit gas.
 contract ArtifactResourceMetering_Test is Test {
     uint128 internal minimumBaseFee;
     uint128 internal maximumBaseFee;
@@ -257,10 +260,7 @@ contract ArtifactResourceMetering_Test is Test {
     bytes32 internal emptyReturnData =
         0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470;
 
-    /**
-     * @notice Sets up the tests by getting constants from the ResourceMetering
-     *         contract.
-     */
+    /// @dev Sets up the tests with constants from the ResourceMetering contract.
     function setUp() public {
         vm.roll(1_000_000);
 
@@ -275,11 +275,8 @@ contract ArtifactResourceMetering_Test is Test {
         try vm.removeFile(outfile) {} catch {}
     }
 
-    /**
-     * @notice Generate a CSV file. The call to `meter` should be called with at
-     *         most the L1 block gas limit. Without specifying the amount of
-     *         gas, it can take very long to execute.
-     */
+    /// @dev Generates a CSV file. No more than the L1 block gas limit should
+    ///      be supplied to the `meter` function to avoid long execution time.
     function test_meter_generateArtifact_succeeds() external {
         vm.writeLine(
             outfile,

packages/contracts-bedrock/contracts/test/SystemConfig.t.sol

 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.15;
 
+// Testing utilities
 import { CommonTest } from "./CommonTest.t.sol";
-import { SystemConfig } from "../L1/SystemConfig.sol";
-import { ResourceMetering } from "../L1/ResourceMetering.sol";
+
+// Libraries
 import { Constants } from "../libraries/Constants.sol";
 
+// Target contract dependencies
+import { ResourceMetering } from "../L1/ResourceMetering.sol";
+
+// Target contract
+import { SystemConfig } from "../L1/SystemConfig.sol";
+
 contract SystemConfig_Init is CommonTest {
     SystemConfig sysConf;
 
@@ -34,6 +41,8 @@ contract SystemConfig_Init is CommonTest {
 }
 
 contract SystemConfig_Initialize_TestFail is SystemConfig_Init {
+
+    /// @dev Tests that initialization reverts if the gas limit is too low.
     function test_initialize_lowGasLimit_reverts() external {
         uint64 minimumGasLimit = sysConf.minimumGasLimit();
 
@@ -60,32 +69,40 @@ contract SystemConfig_Initialize_TestFail is SystemConfig_Init {
 }
 
 contract SystemConfig_Setters_TestFail is SystemConfig_Init {
+
+    /// @dev Tests that `setBatcherHash` reverts if the caller is not the owner.
     function test_setBatcherHash_notOwner_reverts() external {
         vm.expectRevert("Ownable: caller is not the owner");
         sysConf.setBatcherHash(bytes32(hex""));
     }
 
+    /// @dev Tests that `setGasConfig` reverts if the caller is not the owner.
     function test_setGasConfig_notOwner_reverts() external {
         vm.expectRevert("Ownable: caller is not the owner");
         sysConf.setGasConfig(0, 0);
     }
 
+    /// @dev Tests that `setGasLimit` reverts if the caller is not the owner.
     function test_setGasLimit_notOwner_reverts() external {
         vm.expectRevert("Ownable: caller is not the owner");
         sysConf.setGasLimit(0);
     }
 
+    /// @dev Tests that `setUnsafeBlockSigner` reverts if the caller is not the owner.
     function test_setUnsafeBlockSigner_notOwner_reverts() external {
         vm.expectRevert("Ownable: caller is not the owner");
         sysConf.setUnsafeBlockSigner(address(0x20));
     }
 
+    /// @dev Tests that `setResourceConfig` reverts if the caller is not the owner.
     function test_setResourceConfig_notOwner_reverts() external {
         ResourceMetering.ResourceConfig memory config = Constants.DEFAULT_RESOURCE_CONFIG();
         vm.expectRevert("Ownable: caller is not the owner");
         sysConf.setResourceConfig(config);
     }
 
+    /// @dev Tests that `setResourceConfig` reverts if the min base fee
+    ///      is greater than the maximum allowed base fee.
     function test_setResourceConfig_badMinMax_reverts() external {
         ResourceMetering.ResourceConfig memory config = ResourceMetering.ResourceConfig({
             maxResourceLimit: 20_000_000,
@@ -100,6 +117,8 @@ contract SystemConfig_Setters_TestFail is SystemConfig_Init {
         sysConf.setResourceConfig(config);
     }
 
+    /// @dev Tests that `setResourceConfig` reverts if the baseFeeMaxChangeDenominator
+    ///      is zero.
     function test_setResourceConfig_zeroDenominator_reverts() external {
         ResourceMetering.ResourceConfig memory config = ResourceMetering.ResourceConfig({
             maxResourceLimit: 20_000_000,
@@ -114,6 +133,7 @@ contract SystemConfig_Setters_TestFail is SystemConfig_Init {
         sysConf.setResourceConfig(config);
     }
 
+    /// @dev Tests that `setResourceConfig` reverts if the gas limit is too low.
     function test_setResourceConfig_lowGasLimit_reverts() external {
         uint64 gasLimit = sysConf.gasLimit();
 
@@ -130,6 +150,8 @@ contract SystemConfig_Setters_TestFail is SystemConfig_Init {
         sysConf.setResourceConfig(config);
     }
 
+    /// @dev Tests that `setResourceConfig` reverts if the elasticity multiplier
+    ///      and max resource limit are configured such that there is a loss of precision.
     function test_setResourceConfig_badPrecision_reverts() external {
         ResourceMetering.ResourceConfig memory config = ResourceMetering.ResourceConfig({
             maxResourceLimit: 20_000_000,
@@ -152,6 +174,7 @@ contract SystemConfig_Setters_Test is SystemConfig_Init {
         bytes data
     );
 
+    /// @dev Tests that `setBatcherHash` updates the batcher hash successfully.
     function testFuzz_setBatcherHash_succeeds(bytes32 newBatcherHash) external {
         vm.expectEmit(true, true, true, true);
         emit ConfigUpdate(0, SystemConfig.UpdateType.BATCHER, abi.encode(newBatcherHash));
@@ -161,6 +184,7 @@ contract SystemConfig_Setters_Test is SystemConfig_Init {
         assertEq(sysConf.batcherHash(), newBatcherHash);
     }
 
+    /// @dev Tests that `setGasConfig` updates the overhead and scalar successfully.
     function testFuzz_setGasConfig_succeeds(uint256 newOverhead, uint256 newScalar) external {
         vm.expectEmit(true, true, true, true);
         emit ConfigUpdate(
@@ -175,6 +199,7 @@ contract SystemConfig_Setters_Test is SystemConfig_Init {
         assertEq(sysConf.scalar(), newScalar);
     }
 
+    /// @dev Tests that `setGasLimit` updates the gas limit successfully.
     function testFuzz_setGasLimit_succeeds(uint64 newGasLimit) external {
         uint64 minimumGasLimit = sysConf.minimumGasLimit();
         newGasLimit = uint64(
@@ -189,6 +214,7 @@ contract SystemConfig_Setters_Test is SystemConfig_Init {
         assertEq(sysConf.gasLimit(), newGasLimit);
     }
 
+    /// @dev Tests that `setUnsafeBlockSigner` updates the block signer successfully.
     function testFuzz_setUnsafeBlockSigner_succeeds(address newUnsafeSigner) external {
         vm.expectEmit(true, true, true, true);
         emit ConfigUpdate(