From: Christian Grothoff <christian@grothoff.org>
Date: Tue, 3 Feb 2015 17:40:54 +0000 (+0000)
Subject: doxygen, new define
X-Git-Tag: initial-import-from-subversion-38251~2469
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=e8ee3b10972c452c29acf1bc00d9b39765205aa3;p=oweals%2Fgnunet.git

doxygen, new define
---

diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h
index 88d08fb72..88df7d0da 100644
--- a/src/include/gnunet_ats_service.h
+++ b/src/include/gnunet_ats_service.h
@@ -439,12 +439,14 @@ struct Session;
  * and address preferences as determined by ATS.
  *
  * @param cls closure
- * @param address suggested address (including peer identity of the peer)
+ * @param peer for which we suggest an address, NULL if ATS connection died
+ * @param address suggested address (including peer identity of the peer),
+ *             may be NULL to signal disconnect from peer
  * @param session session to use, NULL to establish a new outgoing session
  * @param bandwidth_out assigned outbound bandwidth for the connection,
- *        0 to disconnect
+ *        0 to signal disconnect
  * @param bandwidth_in assigned inbound bandwidth for the connection,
- *        0 to disconnect
+ *        0 to signal disconnect
  */
 typedef void
 (*GNUNET_ATS_AddressSuggestionCallback) (void *cls,
diff --git a/src/include/gnunet_bandwidth_lib.h b/src/include/gnunet_bandwidth_lib.h
index ad8f3a2b9..bbad562dc 100644
--- a/src/include/gnunet_bandwidth_lib.h
+++ b/src/include/gnunet_bandwidth_lib.h
@@ -134,6 +134,12 @@ struct GNUNET_BANDWIDTH_Tracker
 };
 
 
+/**
+ * Convenience definition to use for 0-bandwidth.
+ */
+#define GNUNET_BANDWIDTH_ZERO GNUNET_BANDWIDTH_value_init (0)
+
+
 /**
  * Create a new bandwidth value.
  *