From ec0e5f0189648c2ae77030a671ad86abe326997d Mon Sep 17 00:00:00 2001 From: Markus Teich Date: Fri, 2 Dec 2016 11:45:19 +0100 Subject: [PATCH] fix doc in brandt.h --- brandt.h | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/brandt.h b/brandt.h index f441f00..00f1b91 100644 --- a/brandt.h +++ b/brandt.h @@ -28,14 +28,14 @@ #include +/** opaque, defined in internals.h */ +struct BRANDT_Auction; + /** Enumeration of all possible status reports for a single bidder */ enum BRANDT_BidderStatus { BRANDT_bidder_won, }; -/** opaque, defined in internals.h */ -struct BRANDT_Auction; - /** * An array of this struct is given to the application by the BRANDT_CbResult() * callback. One instance represents the status of a single bidder. @@ -122,6 +122,7 @@ BRANDT_init (struct GNUNET_CRYPTO_EccDlogContext *dlogctx); * @param[out] num_prices Amount of possible prices. May be NULL. * @param[out] m Auction mode. May be NULL. * @param[out] outcome_public Outcome setting. May be NULL. + * @return 0 on success, -1 on failure. */ int BRANDT_parse_desc (const void *auction_desc, @@ -136,9 +137,9 @@ BRANDT_parse_desc (const void *auction_desc, /** * Join an auction described by the @a auction_desc parameter. * + * @param[in] result Pointer to the result callback function * @param[in] broadcast Pointer to the broadcast callback function * @param[in] unicast Pointer to the unicast callback function - * @param[in] result Pointer to the result callback function * @param[in] auction_closure Closure pointer representing the auction. This * will not be touched by libbrandt itself. It is only passed to the callbacks. * @param[in] auction_desc The auction information data published by the seller. @@ -147,6 +148,7 @@ BRANDT_parse_desc (const void *auction_desc, * libbrandt! * @param[in] auction_desc_len The length in byte of the @a auction_desc * structure. + * @param[in] bid How much to bid on this auction. * @return A pointer, which should only be remembered and passed to * libbrandt functions when the client needs to refer to this auction. This is a * black-box pointer, do NOT dereference/change it or the data it points to! @@ -165,8 +167,9 @@ BRANDT_join (BRANDT_CbResult result, /** * Create a new auction described by the @a auction_desc parameter as seller. * - * @param[in] broadcast Pointer to the broadcast callback function * @param[in] result Pointer to the result callback function + * @param[in] broadcast Pointer to the broadcast callback function + * @param[in] start Pointer to the seller start callback function * @param[in] auction_closure Closure pointer representing the auction. This * will not be touched by libbrandt. It is only passed to the callbacks. * @param[out] auction_desc The auction information data as an opaque data