summaryrefslogtreecommitdiff
path: root/brandt.h
diff options
context:
space:
mode:
authorMarkus Teich <markus.teich@stusta.mhn.de>2016-06-19 23:21:01 +0200
committerMarkus Teich <markus.teich@stusta.mhn.de>2016-06-19 23:21:01 +0200
commitf6bacc5058d8049a44f25fcc7a931227ddcfb65e (patch)
tree2cf8eb2c7ffa654f0b924f68681ba92266d8cbdb /brandt.h
parent977de7747484be89d00aa70924cb937d0bed786c (diff)
some doxygen fixes
Diffstat (limited to 'brandt.h')
-rw-r--r--brandt.h34
1 files changed, 17 insertions, 17 deletions
diff --git a/brandt.h b/brandt.h
index b7ebf5b..0e41021 100644
--- a/brandt.h
+++ b/brandt.h
@@ -26,7 +26,7 @@
#include <stdint.h>
/**
- * FIXME.
+ * \todo.
*/
struct BRANDT_Auction;
@@ -34,7 +34,7 @@ struct BRANDT_Auction;
* Functions of this type are called by libbrandt to broadcast messages to the
* blackboard of a specific auction.
*
- * TODO: how must the message be handled? (encryption, auth, reliability, …)
+ * \todo: how must the message be handled? (encryption, auth, reliability, …)
*
* @param[in] auction_closure Closure pointer representing the respective
* auction. This is the Pointer given to BRANDT_join().
@@ -53,7 +53,7 @@ typedef int
* Functions of this type are called by libbrandt to unicast messages to the
* seller of a specific auction.
*
- * TODO: how must the message be handled? (encryption, auth, reliability, …)
+ * \todo: how must the message be handled? (encryption, auth, reliability, …)
*
* @param[in] auction_closure Closure pointer representing the respective
* auction. This is the Pointer given to BRANDT_join().
@@ -71,8 +71,8 @@ typedef int
* Functions of this type are called by libbrandt to report the auction outcome
* or malicious/erroneous participants.
*
- * TODO: update price type.
- * TODO: export proof of erroneous behaviour.
+ * \todo: update price type.
+ * \todo: export proof of erroneous behaviour.
*
* @param[in] auction_closure Closure pointer representing the respective
* auction. This is the Pointer given to BRANDT_join() / BRANDT_new().
@@ -115,16 +115,16 @@ BRANDT_join (BRANDT_BroadcastCallback broadcast,
const void * auction_closure,
const void * auction_data,
size_t auction_data_len);
-/* FIXME: where do I specify my bid? */
+/* \todo: where do I specify my bid? */
-/* FIXME: Distinguish handles for seller/buyers */
-/* FIXME: have cancellation (BRANDT_join_cancel()) */
-/* FIXME: provide means to extract a hash from auction data to */
+/* \todo: Distinguish handles for seller/buyers */
+/* \todo: have cancellation (BRANDT_join_cancel()) */
+/* \todo: provide means to extract a hash from auction data to */
/* tie cryptographic operations to application-readable proposal */
-/* FIXME: have separate function to export 'out' variables */
-/* FIXME: might want to specify timeout? How do we deal with time? */
-/* FIXME: separate creating an auction from starting it; initial */
+/* \todo: have separate function to export 'out' variables */
+/* \todo: might want to specify timeout? How do we deal with time? */
+/* \todo: separate creating an auction from starting it; initial */
/* setup needs more auction proposal details (hash, timeout, */
/* bid structure), later we need to know # participants */
/**
@@ -140,15 +140,15 @@ BRANDT_join (BRANDT_BroadcastCallback broadcast,
* @param[out] auction_data_len The length in bytes of the @a auction_data
* structure. Will be filled by BRANDT_new().
* @param[in] num_prices The amount of possible valuations for the sold item(s).
- * If 0, a default of 256 will be used. TODO: what about 1, does it work with
+ * If 0, a default of 256 will be used. \todo: what about 1, does it work with
* second price auctions?
* @param[in] m The mode of the auction. If 0, it will be a first price auction
* where the winner has to pay the price of his bid. If >0 it will be a second
* price auction selling exactly that amount of items and each winner has to pay
- * the price of the highest loosing bid. TODO: what if bidders < m?
+ * the price of the highest loosing bid. \todo: what if bidders < m?
* @param[in] outcome_public If 1, the auction winner and price will be public
* to all participants, if 0, this information will only be revealed to the
- * winner and the seller. => FIXME: Turn into AuctionMode bit flag!
+ * winner and the seller. => \todo: Turn into AuctionMode bit flag!
* @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 access/change it or the data it points to!
@@ -185,7 +185,7 @@ BRANDT_got_broadcast (struct BRANDT_Auction *auction,
* @a msg was received.
* @param[in] msg The message that was received.
* @param[in] msg_len The length in bytes of @a msg.
- * TODO: how to link message to sender id within auction?
+ * \todo: how to link message to sender id within auction?
* ANSWER: on start, know that we have 'n' participants, here give
* participant number (1..n)
*/
@@ -195,6 +195,6 @@ BRANDT_got_unicast (struct BRANDT_Auction *auction,
size_t msg_len);
-/**TODO: Error handling functions? */
+/**\todo: Error handling functions? */
#endif /* ifndef _BRANDT_BRANDT_H */