From: Matthias Wachs <wachs@net.in.tum.de>
Date: Mon, 3 May 2010 14:40:42 +0000 (+0000)
Subject: Added documentation for defines
X-Git-Tag: initial-import-from-subversion-38251~21913
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=3b5d33b3e193d0f6843b2d87471df90c5ceb2dfa;p=oweals%2Fgnunet.git

Added documentation for defines
---

diff --git a/src/hostlist/hostlist-client.h b/src/hostlist/hostlist-client.h
index fdf7d6e64..7716dd7c9 100644
--- a/src/hostlist/hostlist-client.h
+++ b/src/hostlist/hostlist-client.h
@@ -32,18 +32,48 @@
 #include "gnunet_util_lib.h"
 #include "gnunet_time_lib.h"
 
+/**
+ * Maximum number of hostlist that are saved
+ */
 #define MAX_NUMBER_HOSTLISTS 30
+
+/**
+ * Time intervall hostlists are saved to disk
+ */
 #define SAVING_INTERVALL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 30)
+
+/**
+ * Time interval between two hostlist tests
+ */
 #define TESTING_INTERVALL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
+
+/**
+ * Time interval for download dispatcher before a download is re-scheduled
+ */
 #define WAITING_INTERVALL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
 
-/*
+/**
  * Defines concerning the hostlist quality metric
  */
 
+/**
+ * Initial quality of a new created hostlist
+ */
 #define HOSTLIST_INITIAL 10000
+
+/**
+ * Value subtracted each time a hostlist download fails
+ */
 #define HOSTLIST_FAILED_DOWNLOAD 100
+
+/**
+ * Value added each time a hostlist download is successful
+ */
 #define HOSTLIST_SUCCESSFUL_DOWNLOAD 100
+
+/**
+ * Value added for each valid HELLO recived during a hostlist download
+ */
 #define HOSTLIST_SUCCESSFUL_HELLO 1