add doc for test-case function

This commit is contained in:
Markus Teich 2016-11-23 23:14:48 +01:00
parent ad20666c33
commit b0042a588a

View File

@ -364,6 +364,18 @@ run_auction (void *arg)
}
/**
* Test a specific auction setup.
*
* @param[in] n number of bidders.
* @param[in] k number of different prices.
* @param[in] bids The bid array. Must contain exactly @a n elements each less
* than @a k.
* @param[in] m If 0 it's a first price auction, else an M+1st price auction
* specifying the M.
* @param[in] outcome_public 1 means public outcome, 0 means private outcome.
* @return 0 on success, 1 on failure
*/
static int
test_auction (uint16_t n,
uint16_t k,