Added Natspec to the interfaces (#751)

* Documented all of the functions, events, and errors in the interfaces

* Added better Natspec documentation to `Hyperdrive`

* Update contracts/src/interfaces/IERC20Forwarder.sol

Co-authored-by: Jonny Rhea <[email protected]>

* Update contracts/src/interfaces/IHyperdriveCore.sol

Co-authored-by: Jonny Rhea <[email protected]>

* Addressed review feedback from @jrhea

---------

Co-authored-by: Jonny Rhea <[email protected]>

Author: jalextowle

contracts/src/deployers/HyperdriveDeployerCoordinator.sol

@@ -92,7 +92,7 @@ abstract contract HyperdriveDeployerCoordinator is
     /// @param _deployConfig The deploy configuration of the Hyperdrive pool.
     /// @param _extraData The extra data that contains the pool and sweep targets.
     /// @param _salt The create2 salt used to deploy Hyperdrive.
-    /// @return The address of the newly deployed ERC4626Hyperdrive Instance.
+    /// @return The address of the newly deployed Hyperdrive instance.
     function deploy(
         bytes32 _deploymentId,
         IHyperdrive.PoolDeployConfig memory _deployConfig,

contracts/src/deployers/erc4626/ERC4626HyperdriveCoreDeployer.sol

@@ -16,33 +16,33 @@ contract ERC4626HyperdriveCoreDeployer is IHyperdriveCoreDeployer {
     /// @notice Deploys a Hyperdrive instance with the given parameters.
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _extraData The extra data that contains the ERC4626 vault.
-    /// @param target0 The target0 address.
-    /// @param target1 The target1 address.
-    /// @param target2 The target2 address.
-    /// @param target3 The target3 address.
-    /// @param target4 The target4 address.
+    /// @param _target0 The target0 address.
+    /// @param _target1 The target1 address.
+    /// @param _target2 The target2 address.
+    /// @param _target3 The target3 address.
+    /// @param _target4 The target4 address.
     /// @param _salt The create2 salt used in the deployment.
     /// @return The address of the newly deployed ERC4626Hyperdrive instance.
     function deploy(
         IHyperdrive.PoolConfig memory _config,
         bytes memory _extraData,
-        address target0,
-        address target1,
-        address target2,
-        address target3,
-        address target4,
+        address _target0,
+        address _target1,
+        address _target2,
+        address _target3,
+        address _target4,
         bytes32 _salt
     ) external returns (address) {
         address vault = abi.decode(_extraData, (address));
         return (
             address(
                 new ERC4626Hyperdrive{ salt: _salt }(
                     _config,
-                    target0,
-                    target1,
-                    target2,
-                    target3,
-                    target4,
+                    _target0,
+                    _target1,
+                    _target2,
+                    _target3,
+                    _target4,
                     IERC4626(vault)
                 )
             )

contracts/src/deployers/erc4626/ERC4626Target0Deployer.sol

@@ -17,7 +17,7 @@ contract ERC4626Target0Deployer is IHyperdriveTargetDeployer {
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _extraData The extra data that contains the pool and sweep targets.
     /// @param _salt The create2 salt used in the deployment.
-    /// @return The address of the newly deployed ERC4626Target0 Instance.
+    /// @return The address of the newly deployed ERC4626Target0 instance.
     function deploy(
         IHyperdrive.PoolConfig memory _config,
         bytes memory _extraData,

contracts/src/deployers/erc4626/ERC4626Target1Deployer.sol

@@ -17,7 +17,7 @@ contract ERC4626Target1Deployer is IHyperdriveTargetDeployer {
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _extraData The extra data that contains the pool and sweep targets.
     /// @param _salt The create2 salt used in the deployment.
-    /// @return The address of the newly deployed ERC4626Target1 Instance.
+    /// @return The address of the newly deployed ERC4626Target1 instance.
     function deploy(
         IHyperdrive.PoolConfig memory _config,
         bytes memory _extraData,

contracts/src/deployers/erc4626/ERC4626Target2Deployer.sol

@@ -17,7 +17,7 @@ contract ERC4626Target2Deployer is IHyperdriveTargetDeployer {
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _extraData The extra data that contains the pool and sweep targets.
     /// @param _salt The create2 salt used in the deployment.
-    /// @return The address of the newly deployed ERC4626Target2 Instance.
+    /// @return The address of the newly deployed ERC4626Target2 instance.
     function deploy(
         IHyperdrive.PoolConfig memory _config,
         bytes memory _extraData,

contracts/src/deployers/erc4626/ERC4626Target3Deployer.sol

@@ -17,7 +17,7 @@ contract ERC4626Target3Deployer is IHyperdriveTargetDeployer {
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _extraData The extra data that contains the pool and sweep targets.
     /// @param _salt The create2 salt used in the deployment.
-    /// @return The address of the newly deployed ERC4626Target3 Instance.
+    /// @return The address of the newly deployed ERC4626Target3 instance.
     function deploy(
         IHyperdrive.PoolConfig memory _config,
         bytes memory _extraData,

contracts/src/deployers/erc4626/ERC4626Target4Deployer.sol

@@ -17,7 +17,7 @@ contract ERC4626Target4Deployer is IHyperdriveTargetDeployer {
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _extraData The extra data that contains the pool and sweep targets.
     /// @param _salt The create2 salt used in the deployment.
-    /// @return The address of the newly deployed ERC4626Target4 Instance.
+    /// @return The address of the newly deployed ERC4626Target4 instance.
     function deploy(
         IHyperdrive.PoolConfig memory _config,
         bytes memory _extraData,

contracts/src/deployers/steth/StETHHyperdriveCoreDeployer.sol

@@ -30,7 +30,7 @@ contract StETHHyperdriveCoreDeployer is IHyperdriveCoreDeployer {
     /// @param target3 The target3 address.
     /// @param target4 The target4 address.
     /// @param _salt The create2 salt used in the deployment.
-    /// @return The address of the newly deployed StETHHyperdrive Instance.
+    /// @return The address of the newly deployed StETHHyperdrive instance.
     function deploy(
         IHyperdrive.PoolConfig memory _config,
         bytes memory, // unused extra data

contracts/src/deployers/steth/StETHTarget0Deployer.sol

@@ -25,7 +25,7 @@ contract StETHTarget0Deployer is IHyperdriveTargetDeployer {
     /// @notice Deploys a target0 instance with the given parameters.
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _salt The create2 salt used in the deployment.
-    /// @return The address of the newly deployed StETHTarget0 Instance.
+    /// @return The address of the newly deployed StETHTarget0 instance.
     function deploy(
         IHyperdrive.PoolConfig memory _config,
         bytes memory, // unused extra data

contracts/src/deployers/steth/StETHTarget1Deployer.sol

@@ -25,7 +25,7 @@ contract StETHTarget1Deployer is IHyperdriveTargetDeployer {
     /// @notice Deploys a target1 instance with the given parameters.
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _salt The create2 salt used in the deployment.
-    /// @return The address of the newly deployed StETHTarget1 Instance.
+    /// @return The address of the newly deployed StETHTarget1 instance.
     function deploy(
         IHyperdrive.PoolConfig memory _config,
         bytes memory, // unused extra data