From 3d513f1d00874f3107ca97e81f9af0844fea51ed Mon Sep 17 00:00:00 2001 From: Loredana Date: Sun, 15 Oct 2017 23:43:34 +0300 Subject: [PATCH] Add some additional comments --- contracts/auction.sol | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/contracts/auction.sol b/contracts/auction.sol index a92870b..244512e 100644 --- a/contracts/auction.sol +++ b/contracts/auction.sol @@ -33,13 +33,13 @@ contract DutchAuction { // Price decay function parameters to be changed depending on the desired outcome - // Starting price in WEI; e.g. 2 * 10 ** 18 + // Starting price in WEI, has to be > 0; e.g. 2 * 10 ** 18 uint public price_start; - // Divisor constant; e.g. 524880000 + // Divisor constant, has to be > 0; e.g. 524880000 uint public price_constant; - // Divisor exponent; e.g. 3 + // Divisor exponent, has to be >= 0; e.g. 3 uint32 public price_exponent; // For calculating elapsed time for price @@ -217,7 +217,8 @@ contract DutchAuction { AuctionStarted(start_time, start_block); } - /// @notice Finalize the auction - sets the final RDN token price and changes the auction + /// @notice Finalize the auction - sets the final RDN token price and changes the auction. + /// Function is safe to be called by anyone. /// stage after no bids are allowed anymore. /// @dev Finalize auction and set the final RDN token price. function finalizeAuction() public atStage(Stages.AuctionStarted)