chore: prettier

Author: jaybuidl

contracts/src/CurateFactory.sol

@@ -1,56 +1,62 @@
 // SPDX-License-Identifier: MIT
 
-/**
- *  @authors: [@mtsalenc*, @unknownunknown1]
- *  @reviewers: []
- *  @auditors: []
- *  @bounties: []
- *  @deployments: []
- */
+/// @custom:authors: [@mtsalenc*, @unknownunknown1]
+/// @custom:reviewers: []
+/// @custom:auditors: []
+/// @custom:bounties: []
+/// @custom:deployments: []
 
 pragma solidity 0.8.18;
 
 import {Curate, IArbitratorV2} from "./CurateV2.sol";
 
-/**
- *  @title CurateFactory
- *  This contract acts as a registry for Curate instances.
- */
+/// @title CurateFactory
+/// This contract acts as a registry for Curate instances.
 contract CurateFactory {
-    /**
-     *  @dev Emitted when a new Curate contract is deployed using this factory. TODO: change TCR mentions.
-     *  @param _address The address of the newly deployed Curate contract.
-     */
+    // ************************************* //
+    // *              Events               * //
+    // ************************************* //
+
+    /// @dev Emitted when a new Curate contract is deployed using this factory. TODO: change TCR mentions.
+    /// @param _address The address of the newly deployed Curate contract.
     event NewGTCR(Curate indexed _address);
 
+    // ************************************* //
+    // *             Storage               * //
+    // ************************************* //
+
     Curate[] public instances;
     address public curate;
 
-    /**
-     *  @dev Constructor.
-     *  @param _curate Address of the Curate contract that is going to be used for each new deployment.
-     */
+    // ************************************* //
+    // *            Constructor            * //
+    // ************************************* //
+
+    /// @dev Constructor.
+    /// @param _curate Address of the Curate contract that is going to be used for each new deployment.
     constructor(address _curate) {
         curate = _curate;
     }
 
-    /**
-     * @dev Deploy the arbitrable curated registry.
-     * @param _arbitrator Arbitrator to resolve potential disputes. The arbitrator is trusted to support appeal periods and not reenter.
-     * @param _arbitratorExtraData Extra data for the trusted arbitrator contract.
-     * @param _connectedTCR The address of the Curate contract that stores related Curate addresses. This parameter can be left empty.
-     * @param _registrationTemplateParameters Template and data mappings json for registration requests.
-     * @param _removalTemplateParameters Template and data mappings json for removal requests.
-     * @param _governor The trusted governor of this contract.
-     * @param _baseDeposits The base deposits for requests/challenges as follows:
-     *  - The base deposit to submit an item.
-     *  - The base deposit to remove an item.
-     *  - The base deposit to challenge a submission.
-     *  - The base deposit to challenge a removal request.
-     * @param _challengePeriodDuration The time in seconds parties have to challenge a request.
-     * @param _relayerContract The address of the relay contract to add/remove items directly.
-     * @param _templateRegistry The dispute template registry.
-     */
+    // ************************************* //
+    // *         State Modifiers           * //
+    // ************************************* //
+
+    /// @dev Deploy the arbitrable curated registry.
+    /// @param _arbitrator Arbitrator to resolve potential disputes. The arbitrator is trusted to support appeal periods and not reenter.
+    /// @param _arbitratorExtraData Extra data for the trusted arbitrator contract.
+    /// @param _connectedTCR The address of the Curate contract that stores related Curate addresses. This parameter can be left empty.
+    /// @param _registrationTemplateParameters Template and data mappings json for registration requests.
+    /// @param _removalTemplateParameters Template and data mappings json for removal requests.
+    /// @param _governor The trusted governor of this contract.
+    /// @param _baseDeposits The base deposits for requests/challenges as follows:
+    /// - The base deposit to submit an item.
+    /// - The base deposit to remove an item.
+    /// - The base deposit to challenge a submission.
+    /// - The base deposit to challenge a removal request.
+    /// @param _challengePeriodDuration The time in seconds parties have to challenge a request.
+    /// @param _relayerContract The address of the relay contract to add/remove items directly.
+    /// @param _templateRegistry The dispute template registry.
     function deploy(
         IArbitratorV2 _arbitrator,
         bytes calldata _arbitratorExtraData,
@@ -80,12 +86,10 @@ contract CurateFactory {
         emit NewGTCR(instance);
     }
 
-    /**
-     * @notice Adaptation of https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/proxy/Clones.sol.
-     * @dev Deploys and returns the address of a clone that mimics the behaviour of `curate`.
-     * @param _implementation Address of the contract to clone.
-     * This function uses the create opcode, which should never revert.
-     */
+    /// @notice Adaptation of https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/proxy/Clones.sol.
+    /// @dev Deploys and returns the address of a clone that mimics the behaviour of `curate`.
+    /// @param _implementation Address of the contract to clone.
+    /// This function uses the create opcode, which should never revert.
     function clone(address _implementation) internal returns (Curate instance) {
         /// @solidity memory-safe-assembly
         assembly {
@@ -99,10 +103,12 @@ contract CurateFactory {
         require(instance != Curate(address(0)), "ERC1167: create failed");
     }
 
-    /**
-     * @return The number of deployed Curate contracts using this factory.
-     */
+    // ************************************* //
+    // *           Public Views            * //
+    // ************************************* //
+
+    /// @return The number of deployed Curate contracts using this factory.
     function count() external view returns (uint256) {
         return instances.length;
     }
-}
+}