From 8f7e67367adea778812bcb3bedebb8c36ef4198d Mon Sep 17 00:00:00 2001
From: Remco Bloemen <remco@wicked.ventures>
Date: Fri, 23 Feb 2018 14:47:44 -0800
Subject: Add documentation

---
 .../protocol/Exchange/MixinWrapperFunctions.sol        | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

(limited to 'packages/contracts')

diff --git a/packages/contracts/src/contracts/current/protocol/Exchange/MixinWrapperFunctions.sol b/packages/contracts/src/contracts/current/protocol/Exchange/MixinWrapperFunctions.sol
index a08fe75ff..1df5145ab 100644
--- a/packages/contracts/src/contracts/current/protocol/Exchange/MixinWrapperFunctions.sol
+++ b/packages/contracts/src/contracts/current/protocol/Exchange/MixinWrapperFunctions.sol
@@ -27,7 +27,10 @@ contract MixinWrapperFunctions is
     MExchangeCore,
     SafeMath
 {
-  
+    /// @param orderAddresses Array of order's maker, taker, makerToken, takerToken, and feeRecipient.
+    /// @param orderValues Array of order's makerTokenAmount, takerTokenAmount, makerFee, takerFee, expirationTimestampInSec, and salt.
+    /// @param takerTokenFillAmount Desired amount of takerToken to fill.
+    /// @param signature Maker's signature of the order.
     function fillOrKillOrder(
         address[5] orderAddresses,
         uint[6] orderValues,
@@ -47,6 +50,7 @@ contract MixinWrapperFunctions is
     /// @param orderAddresses Array of order's maker, taker, makerToken, takerToken, and feeRecipient.
     /// @param orderValues Array of order's makerTokenAmount, takerTokenAmount, makerFee, takerFee, expirationTimestampInSec, and salt.
     /// @param takerTokenFillAmount Desired amount of takerToken to fill.
+    /// @param signature Maker's signature of the order.
     /// @return Success if the transaction did not revert.
     /// @return Total amount of takerToken filled in trade.
     function fillOrderNoThrow(
@@ -110,6 +114,7 @@ contract MixinWrapperFunctions is
     /// @param orderAddresses Array of address arrays containing individual order addresses.
     /// @param orderValues Array of uint256 arrays containing individual order values.
     /// @param takerTokenFillAmounts Array of desired amounts of takerToken to fill in orders.
+    /// @param signatures Maker's signatures of the orders.
     function batchFillOrders(
         address[5][] orderAddresses,
         uint256[6][] orderValues,
@@ -131,6 +136,7 @@ contract MixinWrapperFunctions is
     /// @param orderAddresses Array of address arrays containing individual order addresses.
     /// @param orderValues Array of uint256 arrays containing individual order values.
     /// @param takerTokenFillAmounts Array of desired amounts of takerToken to fill in orders.
+    /// @param signatures Maker's signatures of the orders.
     function batchFillOrKillOrders(
         address[5][] orderAddresses,
         uint[6][] orderValues,
@@ -148,7 +154,13 @@ contract MixinWrapperFunctions is
         }
     }
 
-
+    /// @dev Fills an order with specified parameters and ECDSA signature. Returns false if the transaction would otherwise revert.
+    /// @param orderAddresses Array of order's maker, taker, makerToken, takerToken, and feeRecipient.
+    /// @param orderValues Array of order's makerTokenAmount, takerTokenAmount, makerFee, takerFee, expirationTimestampInSec, and salt.
+    /// @param takerTokenFillAmount Desired amount of takerToken to fill.
+    /// @param signatures Maker's signatures of the orders.
+    /// @return Success if the transaction did not revert.
+    /// @return Total amount of takerToken filled in trade. 
     function batchFillOrdersNoThrow(
         address[5][] orderAddresses,
         uint[6][] orderValues,
@@ -171,6 +183,7 @@ contract MixinWrapperFunctions is
     /// @param orderAddresses Array of address arrays containing individual order addresses.
     /// @param orderValues Array of uint256 arrays containing individual order values.
     /// @param takerTokenFillAmount Desired total amount of takerToken to fill in orders.
+    /// @param signatures Maker's signatures of the orders.
     /// @return Total amount of takerTokenFillAmount filled in orders.
     function marketFillOrders(
         address[5][] orderAddresses,
@@ -197,6 +210,7 @@ contract MixinWrapperFunctions is
     /// @param orderAddresses Array of address arrays containing individual order addresses.
     /// @param orderValues Array of uint256 arrays containing individual order values.
     /// @param takerTokenFillAmount Desired total amount of takerToken to fill in orders.
+    /// @param signatures Maker's signatures of the orders.
     /// @return Total amount of takerTokenFillAmount filled in orders.
     function marketFillOrdersNoThrow(
         address[5][] orderAddresses,
-- 
cgit