Brian/module hook javadoc (#167)

Edited unupdated javadoc anf javadoc in _calculateAdjustedComponentIssuanceUnits.

Author: bweick

contracts/interfaces/IModuleIssuanceHookV2.sol

@@ -64,16 +64,9 @@ interface IModuleIssuanceHookV2 {
 
     /**
      * Adjustments should return the NET CHANGE in POSITION UNITS for each component in the SetToken's
-     * components array. Each entry in the returned arrays should index to the same component in the
-     * SetToken's components array (called using getComponents()). Directional adjustments should be made
-     * according to the following table (i.e. returning a negative debt number means debt is reduced during
-     * issue/redeem):
-     * | ------------------------------------|
-     * | Type    |  Positive |  Negative     |
-     * | -----   |---------- | --------------|
-     * | Equity  | Add Equity| Equity Reduced|
-     * | Debt    | Add Debt  | Debt Reduced  |
-     * | ------------------------------------|
+     * components array (i.e. if debt is greater than current debt position unit return negative number).
+     * Each entry in the returned arrays should index to the same component in the SetToken's components
+     * array (called using getComponents()).
      */
     function getRedemptionAdjustments(
         ISetToken _setToken,

contracts/protocol/modules/SlippageIssuanceModule.sol

@@ -305,6 +305,9 @@ contract SlippageIssuanceModule is DebtIssuanceModule {
         uint256[] memory totalDebtUnits = new uint256[](components.length);
         for (uint256 i = 0; i < components.length; i++) {
             // NOTE: If equityAdjustment is negative and exceeds equityUnits in absolute value this will revert
+            // When adjusting units if we have MORE equity as a result of issuance (ie adjustment is positive) we want to add that
+            // to the unadjusted equity units hence we use addition. Vice versa if we want to remove equity, the adjustment is negative
+            // hence adding adjusts the units lower
             uint256 adjustedEquityUnits = equityUnits[i].toInt256().add(_equityAdjustments[i]).toUint256();
 
             // Use preciseMulCeil to round up to ensure overcollateration when small issue quantities are provided
@@ -314,6 +317,9 @@ contract SlippageIssuanceModule is DebtIssuanceModule {
                 adjustedEquityUnits.preciseMul(_quantity);
 
             // NOTE: If debtAdjustment is negative and exceeds debtUnits in absolute value this will revert
+            // When adjusting units if we have MORE debt as a result of issuance (ie adjustment is negative) we want to increase
+            // the unadjusted debt units hence we subtract. Vice versa if we want to remove debt the adjustment is positive
+            // hence subtracting adjusts the units lower.
             uint256 adjustedDebtUnits = debtUnits[i].toInt256().sub(_debtAdjustments[i]).toUint256();
 
             // Use preciseMulCeil to round up to ensure overcollateration when small redeem quantities are provided