fix(IPerpV2BasisTradingModule): Improve javadocs #246

Sachin · web-flow · commit 3129b3721ab2 · 2022-04-13T21:38:55.000+05:30
diff --git a/contracts/interfaces/IPerpV2BasisTradingModule.sol b/contracts/interfaces/IPerpV2BasisTradingModule.sol
@@ -136,6 +136,8 @@ interface IPerpV2BasisTradingModule is IPerpV2LeverageModuleV2 {
     )
         external;
 
+    /* ============ External Setter Functions ============ */
+
     /**
      * @dev MANAGER ONLY. Update performance fee percentage.
      *
@@ -157,6 +159,8 @@ interface IPerpV2BasisTradingModule is IPerpV2LeverageModuleV2 {
     function updateFeeRecipient(ISetToken _setToken, address _newFeeRecipient)
         external;
 
+    /* ============ External Getter Functions ============ */
+
     /**
      * @dev Adds pending funding payment to tracked settled funding. Returns updated settled funding value in precise units (10e18).
      *

Original file line number	Diff line number	Diff line change
`@@ -136,6 +136,8 @@ interface IPerpV2BasisTradingModule is IPerpV2LeverageModuleV2 {`
`136`	`136`	`)`
`137`	`137`	`external;`
`138`	`138`
	`139`	`+ /* ============ External Setter Functions ============ */`
	`140`	`+`
`139`	`141`	`/**`
`140`	`142`	`* @dev MANAGER ONLY. Update performance fee percentage.`
`141`	`143`	`*`
`@@ -157,6 +159,8 @@ interface IPerpV2BasisTradingModule is IPerpV2LeverageModuleV2 {`
`157`	`159`	`function updateFeeRecipient(ISetToken _setToken, address _newFeeRecipient)`
`158`	`160`	`external;`
`159`	`161`
	`162`	`+ /* ============ External Getter Functions ============ */`
	`163`	`+`
`160`	`164`	`/**`
`161`	`165`	`* @dev Adds pending funding payment to tracked settled funding. Returns updated settled funding value in precise units (10e18).`
`162`	`166`	`*`