(docs) refactor comments

Author: carlolm

contracts/Basket.sol

@@ -48,7 +48,7 @@ contract Basket is StandardToken {
 
   // Modifiers
   modifier onlyArranger {
-    require(msg.sender == arranger); // "Only the Arranger can call this function"
+    require(msg.sender == arranger);                // Check: "Only the Arranger can call this function"
     _;
   }
 
@@ -79,7 +79,7 @@ contract Basket is StandardToken {
     address   _arrangerFeeRecipient,
     uint      _arrangerFee                         // in wei, i.e. 1e18 = 1 ETH
   ) public {
-    // "Constructor: invalid number of tokens and weights"
+    // Check: "Constructor: invalid number of tokens and weights"
     require(_tokens.length > 0 && _tokens.length == _weights.length);
 
     name = _name;
@@ -109,7 +109,7 @@ contract Basket is StandardToken {
     // charging suppliers a fee for every new basket minted
     // skip fees if tokens are minted through swaps
     if (arrangerFee > 0) {
-      // "Insufficient ETH for arranger fee to bundle"
+      // Check: "Insufficient ETH for arranger fee to bundle"
       require(msg.value >= arrangerFee.mul(_quantity).div(10 ** decimals));
       arrangerFeeRecipient.transfer(msg.value);
     } else {
@@ -144,7 +144,7 @@ contract Basket is StandardToken {
     address   _sender,
     address   _recipient
   ) internal returns (bool success) {
-    require(balances[_sender] >= _quantity); // Insufficient basket balance to debundle");
+    require(balances[_sender] >= _quantity);      // Check: "Insufficient basket balance to debundle"
     // decrease holder balance and total supply by _quantity
     balances[_sender] = balances[_sender].sub(_quantity);
     totalSupply_ = totalSupply_.sub(_quantity);
@@ -195,7 +195,7 @@ contract Basket is StandardToken {
   /// @param  _newRecipient                        New fee recipient
   /// @return success                              Operation successful
   function changeArrangerFeeRecipient(address _newRecipient) public onlyArranger returns (bool success) {
-    // "New receipient can not be 0x0 or the same as the current recipient"
+    // Check: "New receipient can not be 0x0 or the same as the current recipient"
     require(_newRecipient != address(0) && _newRecipient != arrangerFeeRecipient);
     address oldRecipient = arrangerFeeRecipient;
     arrangerFeeRecipient = _newRecipient;
@@ -216,6 +216,6 @@ contract Basket is StandardToken {
   }
 
   /// @dev Fallback to reject any ether sent to contract
-  //  "Baskets do not accept ETH transfers"
+  //  Check: "Baskets do not accept ETH transfers"
   function () public payable { revert(); }
 }

contracts/BasketEscrow.sol

@@ -67,7 +67,7 @@ contract BasketEscrow {
 
   // Modifiers
   modifier onlyAdmin {
-    require(msg.sender == admin);                       // "Only the admin can call this function"
+    require(msg.sender == admin);                       // Check: "Only the admin can call this function"
     _;
   }
 
@@ -164,11 +164,11 @@ contract BasketEscrow {
     internal
     returns (uint newOrderIndex)
   {
-    require(_tokenGet == ETH_ADDRESS || basketRegistry.checkBasketExists(_tokenGet)); // "Order not for ETH or invalid basket"
-    require(_tokenGive == ETH_ADDRESS || basketRegistry.checkBasketExists(_tokenGive)); // "Order not for ETH or invalid basket"
+    require(_tokenGet == ETH_ADDRESS || basketRegistry.checkBasketExists(_tokenGet));   // Check: "Order not for ETH or invalid basket"
+    require(_tokenGive == ETH_ADDRESS || basketRegistry.checkBasketExists(_tokenGive)); // Check: "Order not for ETH or invalid basket"
 
     bytes32 hash = sha256(this, _tokenGet, _amountGet, _tokenGive, _amountGive, _expiration, _nonce);
-    require(orders[_orderCreator][hash] == 0); // "Duplicate order"
+    require(orders[_orderCreator][hash] == 0);                                          // Check: "Duplicate order"
 
     orders[_orderCreator][hash] = orderIndex;
     balances[_orderCreator][_tokenGive] = balances[_orderCreator][_tokenGive].add(_amountGive);
@@ -251,8 +251,8 @@ contract BasketEscrow {
   {
     bytes32 hash = sha256(this, _tokenGet, _amountGet, _tokenGive, _amountGive, _expiration, _nonce);
     uint cancelledOrderIndex = orders[_orderCreator][hash];
-    require(cancelledOrderIndex > 0);                    // "Order does not exist"
-    require(filledOrders[_orderCreator][hash] != true);  // "Order has been filled"
+    require(cancelledOrderIndex > 0);                    // Check: "Order does not exist"
+    require(filledOrders[_orderCreator][hash] != true);  // Check: "Order has been filled"
 
     orders[_orderCreator][hash] = 0;
     balances[_orderCreator][_tokenGive] = balances[_orderCreator][_tokenGive].sub(_amountGive);
@@ -335,9 +335,9 @@ contract BasketEscrow {
   {
     bytes32 hash = sha256(this, _tokenGet, _amountGet, _tokenGive, _amountGive, _expiration, _nonce);
     uint filledOrderIndex = orders[_orderCreator][hash];
-    require(filledOrderIndex > 0);                      // "Order does not exist"
-    require(filledOrders[_orderCreator][hash] != true); // "Order has been filled"
-    require(now <= _expiration);                        // "Order has expired"
+    require(filledOrderIndex > 0);                      // Check: "Order does not exist"
+    require(filledOrders[_orderCreator][hash] != true); // Check: "Order has been filled"
+    require(now <= _expiration);                        // Check: "Order has expired"
 
     filledOrders[_orderCreator][hash] = true;
     balances[_orderCreator][_tokenGive] = balances[_orderCreator][_tokenGive].sub(_amountGive);
@@ -390,6 +390,6 @@ contract BasketEscrow {
   }
 
   /// @dev Fallback to reject any ether sent directly to contract
-  //  "BasketEscrow does not accept ETH transfers"
+  //  Check: "BasketEscrow does not accept ETH transfers"
   function () public payable { revert(); }
 }

contracts/BasketFactory.sol

@@ -39,7 +39,7 @@ contract BasketFactory {
 
   // Modifiers
   modifier onlyAdmin {
-    require(msg.sender == admin);                   // "Only the admin can call this function"
+    require(msg.sender == admin);                   // Check: "Only the admin can call this function"
     _;
   }
 
@@ -85,7 +85,7 @@ contract BasketFactory {
     returns (address newBasket)
   {
     // charging arrangers a fee to deploy new basket
-    require(msg.value >= productionFee);           // "Insufficient ETH for basket creation fee"
+    require(msg.value >= productionFee);           // Check: "Insufficient ETH for basket creation fee"
     productionFeeRecipient.transfer(msg.value);
 
     Basket b = new Basket(
@@ -130,6 +130,6 @@ contract BasketFactory {
   }
 
   /// @dev Fallback to reject any ether sent to contract
-  //  "BasketFactory does not accept ETH transfers"
+  //  Check: "BasketFactory does not accept ETH transfers"
   function () public payable { revert(); }
 }

contracts/BasketRegistry.sol

@@ -63,11 +63,11 @@ contract BasketRegistry {
 
   // Modifiers
   modifier onlyBasket {
-    require(basketIndexFromAddress[msg.sender] > 0); // "Only a basket can call this function"
+    require(basketIndexFromAddress[msg.sender] > 0); // Check: "Only a basket can call this function"
     _;
   }
   modifier onlyBasketFactory {
-    require(basketFactoryMap[msg.sender] == true);   // "Only a basket factory can call this function"
+    require(basketFactoryMap[msg.sender] == true);   // Check: "Only a basket factory can call this function"
     _;
   }
 
@@ -88,7 +88,7 @@ contract BasketRegistry {
   /// @param  _basketFactory                       Basket factory address
   /// @return success                              Operation successful
   function whitelistBasketFactory(address _basketFactory) public returns (bool success) {
-    require(msg.sender == admin);                  // "Only an admin can call this function"
+    require(msg.sender == admin);                  // Check: "Only an admin can call this function"
     basketFactoryMap[_basketFactory] = true;
     emit LogWhitelistBasketFactory(_basketFactory);
     return true;
@@ -188,6 +188,6 @@ contract BasketRegistry {
   }
 
   /// @dev Fallback to reject any ether sent to contract
-  //  "BasketRegistry does not accept ETH transfers"
+  //  CHeck: "BasketRegistry does not accept ETH transfers"
   function () public payable { revert(); }
 }