Prettier, commetns

nhtyy · Feb 24, 2022 · 62b7dab · 62b7dab
1 parent c8f2343
commit 62b7dab
Showing 1 changed file with 26 additions and 25 deletions.
diff --git a/src/Vault.sol b/src/Vault.sol
@@ -11,15 +11,21 @@ import "./libraries/yearnVault.sol";
 // minimial approch to self repaying loans, hardcodes 75% LTV or about 133% over-collaterizaiton
 // eventually will make this adjustable
 
+///======================================================================================================================================
+/// 
+/// minimial approch to self repaying loans, hardcodes 75% LTV or about 133% over-collaterizaiton eventually will make this adjustable
+///
+/// Todo: Rebuild on top of SAVault logic
+///
+///======================================================================================================================================
 contract pVault {
 
     using SafeMath for uint;
 
-    // #########################
-    // ##                     ##
-    // ##       Structs       ##
-    // ##                     ##
-    // #########################
+
+///======================================================================================================================================
+/// Data Structures
+///======================================================================================================================================
 
     struct Identity {
         uint256 deposits;
@@ -33,11 +39,10 @@ contract pVault {
         uint16 fee;
     }
 
-    // #########################
-    // ##                     ##
-    // ##       State         ##
-    // ##                     ##
-    // #########################
+
+///======================================================================================================================================
+/// State Variables
+///======================================================================================================================================
 
     // ENSURE COLLATERAL AND SYNTH TOKEN REVERTS ON FAILED TRANSFER
     IERC20 internal collateral;
@@ -76,11 +81,10 @@ contract pVault {
 
     }
 
-    // #########################
-    // ##                     ##
-    // ##     External        ##
-    // ##                     ##
-    // #########################
+
+///======================================================================================================================================
+/// External Functions
+///======================================================================================================================================
 
     function deposit(uint amount) external {
 
@@ -166,11 +170,9 @@ contract pVault {
 
     } 
 
-    // #########################
-    // ##                     ##
-    // ##       Public        ##
-    // ##                     ##
-    // #########################
+///======================================================================================================================================
+/// Public Functions
+///======================================================================================================================================
 
     function harvestAndDistribute() public {
 
@@ -192,11 +194,10 @@ contract pVault {
 
     }
 
-    // #########################
-    // ##                     ##
-    // ##     Internal        ##
-    // ##                     ##
-    // #########################
+
+///======================================================================================================================================
+/// Internal Functions
+///======================================================================================================================================
 
     function getYeild() internal returns (uint) {