diff --git a/contracts/LiquidPledging.sol b/contracts/LiquidPledging.sol index d62c3ac..c809573 100644 --- a/contracts/LiquidPledging.sol +++ b/contracts/LiquidPledging.sol @@ -76,7 +76,7 @@ function donate(uint64 idGiver, uint64 idReceiver) payable { /// @notice Moves value between pledges /// @param idSender ID of the giver, delegate or project admin that is transferring - /// the funds from Pledge to Pledge. This admin must have permissions to move the value + /// the funds from Pledge to Pledge; this admin must have permissions to move the value /// @param idPledge Id of the pledge that's moving the value /// @param amount Quantity of value that's being moved /// @param idReceiver Destination of the value, can be a giver sending to a giver or @@ -263,17 +263,17 @@ function donate(uint64 idGiver, uint64 idReceiver) payable { // Multi pledge methods //////// - // This set of functions makes moving a lot of pledges around much more + // @dev This set of functions makes moving a lot of pledges around much more // efficient (saves gas) than calling these functions in series - // Bit mask used for dividing pledge amounts in Multi pledge methods + /// Bit mask used for dividing pledge amounts in Multi pledge methods uint constant D64 = 0x10000000000000000; - /// @notice `mTransfer` allows for multiple pledges to be transfered efficiently + /// @notice `mTransfer` allows for multiple pledges to be transferred efficiently /// @param idSender ID of the giver, delegate or project admin that is transferring /// the funds from Pledge to Pledge. This admin must have permissions to move the value - /// @param amount An array of pledge amounts and IDs which are extrapalated using the D64 bitmask + /// @param amount An array of pledge amounts and IDs which are extrapolated using the D64 bitmask /// @param idReceiver Destination of the value, can be a giver sending to a giver or /// a delegate, a delegate to another delegate or a project to precommit it to that project function mTransfer(uint64 idSender, uint[] pledgesAmounts, uint64 idReceiver) { @@ -286,7 +286,7 @@ function donate(uint64 idGiver, uint64 idReceiver) payable { } /// @notice `mWithdraw` allows for multiple pledges to be withdrawn efficiently - /// @param amount An array of pledge amounts and IDs which are extrapalated using the D64 bitmask + /// @param amount An array of pledge amounts and IDs which are extrapolated using the D64 bitmask function mWithdraw(uint[] pledgesAmounts) { for (uint i = 0; i < pledgesAmounts.length; i++ ) { uint64 idPledge = uint64( pledgesAmounts[i] & (D64-1) ); @@ -297,7 +297,7 @@ function donate(uint64 idGiver, uint64 idReceiver) payable { } /// @notice `mConfirmPayment` allows for multiple pledges to be confirmed efficiently - /// @param amount An array of pledge amounts and IDs which are extrapalated using the D64 bitmask + /// @param amount An array of pledge amounts and IDs which are extrapolated using the D64 bitmask function mConfirmPayment(uint[] pledgesAmounts) { for (uint i = 0; i < pledgesAmounts.length; i++ ) { uint64 idPledge = uint64( pledgesAmounts[i] & (D64-1) ); @@ -308,7 +308,7 @@ function donate(uint64 idGiver, uint64 idReceiver) payable { } /// @notice `mCancelPayment` allows for multiple pledges to be cancelled efficiently - /// @param amount An array of pledge amounts and IDs which are extrapalated using the D64 bitmask + /// @param amount An array of pledge amounts and IDs which are extrapolated using the D64 bitmask function mCancelPayment(uint[] pledgesAmounts) { for (uint i = 0; i < pledgesAmounts.length; i++ ) { uint64 idPledge = uint64( pledgesAmounts[i] & (D64-1) ); @@ -319,7 +319,7 @@ function donate(uint64 idGiver, uint64 idReceiver) payable { } /// @notice `mNormalizePledge` allows for multiple pledges to be normalized efficiently - /// @param amount An array of pledge IDs which are extrapalated using the D64 bitmask + /// @param amount An array of pledge IDs which are extrapolated using the D64 bitmask function mNormalizePledge(uint[] pledges) returns(uint64) { for (uint i = 0; i < pledges.length; i++ ) { uint64 idPledge = uint64( pledges[i] & (D64-1) );