aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarkus Teich <markus.teich@stusta.mhn.de>2016-12-02 11:45:19 +0100
committerMarkus Teich <markus.teich@stusta.mhn.de>2016-12-02 11:45:19 +0100
commitec0e5f0189648c2ae77030a671ad86abe326997d (patch)
tree64eaf7887093b365555e03c57f4338a42d7a4aa6
parent0ba8f80bc1ac4ac88b007626eea493e7560ea4cb (diff)
downloadlibbrandt-ec0e5f0189648c2ae77030a671ad86abe326997d.tar.gz
libbrandt-ec0e5f0189648c2ae77030a671ad86abe326997d.zip
fix doc in brandt.h
-rw-r--r--brandt.h13
1 files 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 @@
28 28
29#include <gnunet/gnunet_util_lib.h> 29#include <gnunet/gnunet_util_lib.h>
30 30
31/** opaque, defined in internals.h */
32struct BRANDT_Auction;
33
31/** Enumeration of all possible status reports for a single bidder */ 34/** Enumeration of all possible status reports for a single bidder */
32enum BRANDT_BidderStatus { 35enum BRANDT_BidderStatus {
33 BRANDT_bidder_won, 36 BRANDT_bidder_won,
34}; 37};
35 38
36/** opaque, defined in internals.h */
37struct BRANDT_Auction;
38
39/** 39/**
40 * An array of this struct is given to the application by the BRANDT_CbResult() 40 * An array of this struct is given to the application by the BRANDT_CbResult()
41 * callback. One instance represents the status of a single bidder. 41 * callback. One instance represents the status of a single bidder.
@@ -122,6 +122,7 @@ BRANDT_init (struct GNUNET_CRYPTO_EccDlogContext *dlogctx);
122 * @param[out] num_prices Amount of possible prices. May be NULL. 122 * @param[out] num_prices Amount of possible prices. May be NULL.
123 * @param[out] m Auction mode. May be NULL. 123 * @param[out] m Auction mode. May be NULL.
124 * @param[out] outcome_public Outcome setting. May be NULL. 124 * @param[out] outcome_public Outcome setting. May be NULL.
125 * @return 0 on success, -1 on failure.
125 */ 126 */
126int 127int
127BRANDT_parse_desc (const void *auction_desc, 128BRANDT_parse_desc (const void *auction_desc,
@@ -136,9 +137,9 @@ BRANDT_parse_desc (const void *auction_desc,
136/** 137/**
137 * Join an auction described by the @a auction_desc parameter. 138 * Join an auction described by the @a auction_desc parameter.
138 * 139 *
140 * @param[in] result Pointer to the result callback function
139 * @param[in] broadcast Pointer to the broadcast callback function 141 * @param[in] broadcast Pointer to the broadcast callback function
140 * @param[in] unicast Pointer to the unicast callback function 142 * @param[in] unicast Pointer to the unicast callback function
141 * @param[in] result Pointer to the result callback function
142 * @param[in] auction_closure Closure pointer representing the auction. This 143 * @param[in] auction_closure Closure pointer representing the auction. This
143 * will not be touched by libbrandt itself. It is only passed to the callbacks. 144 * will not be touched by libbrandt itself. It is only passed to the callbacks.
144 * @param[in] auction_desc The auction information data published by the seller. 145 * @param[in] auction_desc The auction information data published by the seller.
@@ -147,6 +148,7 @@ BRANDT_parse_desc (const void *auction_desc,
147 * libbrandt! 148 * libbrandt!
148 * @param[in] auction_desc_len The length in byte of the @a auction_desc 149 * @param[in] auction_desc_len The length in byte of the @a auction_desc
149 * structure. 150 * structure.
151 * @param[in] bid How much to bid on this auction.
150 * @return A pointer, which should only be remembered and passed to 152 * @return A pointer, which should only be remembered and passed to
151 * libbrandt functions when the client needs to refer to this auction. This is a 153 * libbrandt functions when the client needs to refer to this auction. This is a
152 * black-box pointer, do NOT dereference/change it or the data it points to! 154 * black-box pointer, do NOT dereference/change it or the data it points to!
@@ -165,8 +167,9 @@ BRANDT_join (BRANDT_CbResult result,
165/** 167/**
166 * Create a new auction described by the @a auction_desc parameter as seller. 168 * Create a new auction described by the @a auction_desc parameter as seller.
167 * 169 *
168 * @param[in] broadcast Pointer to the broadcast callback function
169 * @param[in] result Pointer to the result callback function 170 * @param[in] result Pointer to the result callback function
171 * @param[in] broadcast Pointer to the broadcast callback function
172 * @param[in] start Pointer to the seller start callback function
170 * @param[in] auction_closure Closure pointer representing the auction. This 173 * @param[in] auction_closure Closure pointer representing the auction. This
171 * will not be touched by libbrandt. It is only passed to the callbacks. 174 * will not be touched by libbrandt. It is only passed to the callbacks.
172 * @param[out] auction_desc The auction information data as an opaque data 175 * @param[out] auction_desc The auction information data as an opaque data