-doxygen, code cleanup

8 files changed, 272 insertions, 159 deletions

diff --git a/src/hostlist/Makefile.am b/src/hostlist/Makefile.am
index e647169c0..d777cd658 100644
--- a/src/hostlist/Makefile.am
+++ b/src/hostlist/Makefile.am
@@ -12,7 +12,8 @@ if USE_COVERAGE
 endif
 
 if HAVE_MHD
- HOSTLIST_SERVER_SOURCES =  hostlist-server.c hostlist-server.h
+ HOSTLIST_SERVER_SOURCES = \
+   gnunet-daemon-hostlist_server.c gnunet-daemon-hostlist_server.h
  GN_LIBMHD = -lmicrohttpd
 endif
 
@@ -23,7 +24,7 @@ endif
 
 gnunet_daemon_hostlist_SOURCES = \
  gnunet-daemon-hostlist.c gnunet-daemon-hostlist.h \
- hostlist-client.c hostlist-client.h \
+ gnunet-daemon-hostlist_client.c gnunet-daemon-hostlist_client.h \
  $(HOSTLIST_SERVER_SOURCES)
 
 gnunet_daemon_hostlist_LDADD = \
diff --git a/src/hostlist/gnunet-daemon-hostlist.c b/src/hostlist/gnunet-daemon-hostlist.c
index a93d7e37d..62ecc5dfd 100644
--- a/src/hostlist/gnunet-daemon-hostlist.c
+++ b/src/hostlist/gnunet-daemon-hostlist.c
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
+     (C) 2007, 2008, 2009, 2014 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -23,10 +23,8 @@
  * @brief code for bootstrapping via hostlist servers
  * @author Christian Grothoff
  */
-
-#include <stdlib.h>
 #include "platform.h"
-#include "hostlist-client.h"
+#include "gnunet-daemon-hostlist_client.h"
 #include "gnunet_core_service.h"
 #include "gnunet_util_lib.h"
 #include "gnunet_protocols.h"
@@ -34,7 +32,7 @@
 
 #if HAVE_MHD
 
-#include "hostlist-server.h"
+#include "gnunet-daemon-hostlist_server.h"
 
 /**
  * Set if we are allowed to advertise our hostlist to others.
@@ -123,9 +121,19 @@ struct GNUNET_HOSTLIST_ADV_Message
 };
 GNUNET_NETWORK_STRUCT_END
 
+
+/**
+ * Our own peer identity.
+ */
 static struct GNUNET_PeerIdentity me;
 
 
+/**
+ * Callback invoked once our connection to CORE service is up.
+ *
+ * @param cls NULL
+ * @param my_identity our peer's identity
+ */
 static void
 core_init (void *cls,
            const struct GNUNET_PeerIdentity *my_identity)
@@ -143,7 +151,8 @@ core_init (void *cls,
  * @return #GNUNET_OK on success
  */
 static int
-advertisement_handler (void *cls, const struct GNUNET_PeerIdentity *peer,
+advertisement_handler (void *cls,
+                       const struct GNUNET_PeerIdentity *peer,
                        const struct GNUNET_MessageHeader *message)
 {
   GNUNET_assert (NULL != client_adv_handler);
@@ -182,7 +191,8 @@ connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
  * @param peer peer identity this notification is about
  */
 static void
-disconnect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
+disconnect_handler (void *cls,
+                    const struct GNUNET_PeerIdentity *peer)
 {
   if (0 == memcmp (&me, peer, sizeof (struct GNUNET_PeerIdentity)))
     return;
@@ -200,13 +210,17 @@ disconnect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
 /**
  * Last task run during shutdown.  Disconnects us from
  * the other services.
+ *
+ * @param cls NULL
+ * @param tc scheduler context
  */
 static void
-cleaning_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+cleaning_task (void *cls,
+               const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Hostlist daemon is shutting down\n");
-  if (core != NULL)
+  if (NULL != core)
   {
     GNUNET_CORE_disconnect (core);
     core = NULL;
@@ -221,7 +235,7 @@ cleaning_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
     GNUNET_HOSTLIST_server_stop ();
   }
 #endif
-  if (stats != NULL)
+  if (NULL != stats)
   {
     GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
     stats = NULL;
@@ -238,7 +252,9 @@ cleaning_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  * @param cfg configuration
  */
 static void
-run (void *cls, char *const *args, const char *cfgfile,
+run (void *cls,
+     char *const *args,
+     const char *cfgfile,
      const struct GNUNET_CONFIGURATION_Handle *cfg)
 {
   static const struct GNUNET_CORE_MessageHandler learn_handlers[] = {
@@ -248,15 +264,14 @@ run (void *cls, char *const *args, const char *cfgfile,
   static const struct GNUNET_CORE_MessageHandler no_learn_handlers[] = {
     {NULL, 0, 0}
   };
-  if ((!bootstrapping) && (!learning)
+  if ((! bootstrapping) && (! learning)
 #if HAVE_MHD
-      && (!provide_hostlist)
+      && (! provide_hostlist)
 #endif
       )
   {
     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                _
-                ("None of the functions for the hostlist daemon were enabled.  I have no reason to run!\n"));
+                _("None of the functions for the hostlist daemon were enabled.  I have no reason to run!\n"));
     return;
   }
   stats = GNUNET_STATISTICS_create ("hostlist", cfg);
@@ -332,7 +347,8 @@ main (int argc, char *const *argv)
   ret =
       (GNUNET_OK ==
        GNUNET_PROGRAM_run (argc, argv, "hostlist",
-                           _("GNUnet hostlist server and client"), options,
+                           _("GNUnet hostlist server and client"),
+                           options,
                            &run, NULL)) ? 0 : 1;
   GNUNET_free ((void*) argv);
   return ret;
diff --git a/src/hostlist/gnunet-daemon-hostlist.h b/src/hostlist/gnunet-daemon-hostlist.h
index 8c9824e0c..ca9895dad 100644
--- a/src/hostlist/gnunet-daemon-hostlist.h
+++ b/src/hostlist/gnunet-daemon-hostlist.h
@@ -25,23 +25,19 @@
  */
 #include <stdlib.h>
 #include "platform.h"
-#include "hostlist-client.h"
-#include "hostlist-server.h"
 #include "gnunet_core_service.h"
-#include "gnunet_getopt_lib.h"
 #include "gnunet_protocols.h"
-#include "gnunet_program_lib.h"
 #include "gnunet_statistics_service.h"
-#include "gnunet_strings_lib.h"
-#include "gnunet_time_lib.h"
 #include "gnunet_util_lib.h"
 
 /**
- * General hostlist daemon debugging.
+ * How long can hostlist URLs be?
  */
-#define DEBUG_HOSTLIST GNUNET_EXTRA_LOGGING
-
 #define MAX_URL_LEN 1000
+
+/**
+ * How many bytes do we download at most from a hostlist server?
+ */
 #define MAX_BYTES_PER_HOSTLISTS 500000
 
 /* end of gnunet-daemon-hostlist.h */
diff --git a/src/hostlist/hostlist-client.c b/src/hostlist/gnunet-daemon-hostlist_client.c
index d4096abc0..20bd8bedd 100644
--- a/src/hostlist/hostlist-client.c
+++ b/src/hostlist/gnunet-daemon-hostlist_client.c
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2001, 2002, 2003, 2004, 2005, 2006, 2009, 2010 Christian Grothoff (and other contributing authors)
+     (C) 2001-2010, 2014 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -17,23 +17,19 @@
      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
      Boston, MA 02111-1307, USA.
 */
-
 /**
- * @file hostlist/hostlist-client.c
+ * @file hostlist/gnunet-daemon-hostlist_client.c
  * @brief hostlist support.  Downloads HELLOs via HTTP.
  * @author Christian Grothoff
  * @author Matthias Wachs
  */
-
 #include "platform.h"
-#include "hostlist-client.h"
-#include "gnunet_core_service.h"
+#include "gnunet-daemon-hostlist_client.h"
 #include "gnunet_hello_lib.h"
 #include "gnunet_statistics_service.h"
 #include "gnunet_transport_service.h"
 #include "gnunet-daemon-hostlist.h"
 #include <curl/curl.h>
-#include "gnunet_util_lib.h"
 
 
 /**
@@ -43,9 +39,50 @@
 #define MIN_CONNECTIONS 4
 
 /**
- * Interval between two advertised hostlist tests
+ * Maximum number of hostlist that are saved
+ */
+#define MAX_NUMBER_HOSTLISTS 30
+
+/**
+ * Time interval hostlists are saved to disk
+ */
+#define SAVING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 30)
+
+/**
+ * Time interval between two hostlist tests
+ */
+#define TESTING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
+
+/**
+ * Time interval for download dispatcher before a download is re-scheduled
+ */
+#define WAITING_INTERVAL 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 TESTING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
+#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
+
+
 
 /**
  * A single hostlist obtained by hostlist advertisements
@@ -281,7 +318,10 @@ static unsigned int stat_connection_count;
  * @return number of bytes that were processed (always size*nmemb)
  */
 static size_t
-callback_download (void *ptr, size_t size, size_t nmemb, void *ctx)
+callback_download (void *ptr,
+                   size_t size,
+                   size_t nmemb,
+                   void *ctx)
 {
   static char download_buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
   const char *cbuf = ptr;
@@ -486,6 +526,7 @@ download_get_url ()
 
 /**
  * Method to save hostlist to a file during hostlist client shutdown
+ *
  * @param shutdown set if called because of shutdown, entries in linked list will be destroyed
  */
 static void
@@ -493,14 +534,15 @@ save_hostlist_file (int shutdown);
 
 
 /**
- * add val2 to val1 with overflow check
+ * Add val2 to val1 with overflow check
  *
  * @param val1 value 1
  * @param val2 value 2
  * @return result
  */
 static uint64_t
-checked_add (uint64_t val1, uint64_t val2)
+checked_add (uint64_t val1,
+             uint64_t val2)
 {
   static uint64_t temp;
   static uint64_t maxv;
@@ -523,7 +565,8 @@ checked_add (uint64_t val1, uint64_t val2)
  * @return result
  */
 static uint64_t
-checked_sub (uint64_t val1, uint64_t val2)
+checked_sub (uint64_t val1,
+             uint64_t val2)
 {
   if (val1 <= val2)
     return 0;
@@ -726,7 +769,8 @@ clean_up ()
  * @param tc task context, unused
  */
 static void
-task_download (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
+task_download (void *cls,
+               const struct GNUNET_SCHEDULER_TaskContext *tc);
 
 
 /**
@@ -795,7 +839,8 @@ download_prepare ()
  * @param tc task context, unused
  */
 static void
-task_download (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+task_download (void *cls,
+               const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   int running;
   struct CURLMsg *msg;
@@ -968,10 +1013,6 @@ download_hostlist ()
     CURL_EASY_SETOPT (curl, CURLOPT_USERAGENT, "GNUnet");
   CURL_EASY_SETOPT (curl, CURLOPT_CONNECTTIMEOUT, 60L);
   CURL_EASY_SETOPT (curl, CURLOPT_TIMEOUT, 60L);
-#if 0
-  /* this should no longer be needed; we're now single-threaded! */
-  CURL_EASY_SETOPT (curl, CURLOPT_NOSIGNAL, 1);
-#endif
   multi = curl_multi_init ();
   if (multi == NULL)
   {
@@ -1017,7 +1058,7 @@ task_download_dispatcher (void *cls,
     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                 "Download in progess, have to wait...\n");
     ti_download_dispatcher_task =
-        GNUNET_SCHEDULER_add_delayed (WAITING_INTERVALL,
+        GNUNET_SCHEDULER_add_delayed (WAITING_INTERVAL,
                                       &task_download_dispatcher, NULL);
   }
 }
@@ -1110,9 +1151,9 @@ task_hostlist_saving (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Hostlists will be saved to file again in %s\n",
-              GNUNET_STRINGS_relative_time_to_string(SAVING_INTERVALL, GNUNET_YES));
+              GNUNET_STRINGS_relative_time_to_string(SAVING_INTERVAL, GNUNET_YES));
   ti_saving_task =
-      GNUNET_SCHEDULER_add_delayed (SAVING_INTERVALL, &task_hostlist_saving,
+      GNUNET_SCHEDULER_add_delayed (SAVING_INTERVAL, &task_hostlist_saving,
                                     NULL);
 }
 
@@ -1257,11 +1298,14 @@ primary_task (void *cls, int success)
  * @param subsystem should be "hostlist", unused
  * @param name will be "milliseconds between hostlist downloads", unused
  * @param value previous delay value, in milliseconds (!)
- * @param is_persistent unused, will be GNUNET_YES
+ * @param is_persistent unused, will be #GNUNET_YES
  */
 static int
-process_stat (void *cls, const char *subsystem, const char *name,
-              uint64_t value, int is_persistent)
+process_stat (void *cls,
+              const char *subsystem,
+              const char *name,
+              uint64_t value,
+              int is_persistent)
 {
   hostlist_delay.rel_value_us = value * 1000LL;
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
@@ -1287,6 +1331,7 @@ load_hostlist_file ()
   uint64_t last_used;
   uint64_t created;
   uint32_t counter;
+  struct GNUNET_BIO_ReadHandle *rh;
 
   uri = NULL;
   if (GNUNET_OK !=
@@ -1309,13 +1354,11 @@ load_hostlist_file ()
     return;
   }
 
-  struct GNUNET_BIO_ReadHandle *rh = GNUNET_BIO_read_open (filename);
-
+  rh = GNUNET_BIO_read_open (filename);
   if (NULL == rh)
   {
     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-                _
-                ("Could not open file `%s' for reading to load hostlists: %s\n"),
+                _("Could not open file `%s' for reading to load hostlists: %s\n"),
                 filename, STRERROR (errno));
     GNUNET_free (filename);
     return;
@@ -1348,11 +1391,14 @@ load_hostlist_file ()
       break;
   }
 
-  GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("%u hostlist URIs loaded from file\n"),
+  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+              _("%u hostlist URIs loaded from file\n"),
               counter);
-  GNUNET_STATISTICS_set (stats, gettext_noop ("# hostlist URIs read from file"),
+  GNUNET_STATISTICS_set (stats,
+                         gettext_noop ("# hostlist URIs read from file"),
                          counter, GNUNET_YES);
-  GNUNET_STATISTICS_set (stats, gettext_noop ("# advertised hostlist URIs"),
+  GNUNET_STATISTICS_set (stats,
+                         gettext_noop ("# advertised hostlist URIs"),
                          linked_list_size, GNUNET_NO);
 
   GNUNET_free_non_null (uri);
@@ -1366,6 +1412,7 @@ load_hostlist_file ()
 
 /**
  * Method to save persistent hostlist file during hostlist client shutdown
+ *
  * @param shutdown set if called because of shutdown, entries in linked list will be destroyed
  */
 static void
@@ -1448,13 +1495,22 @@ save_hostlist_file (int shutdown)
 
 /**
  * Start downloading hostlists from hostlist servers as necessary.
+ *
+ * @param c configuration to use
+ * @param st statistics handle to use
+ * @param ch[OUT] set to handler for CORE connect events
+ * @param dh[OUT] set to handler for CORE disconnect events
+ * @param msgh[OUT] set to handler for CORE advertisement messages
+ * @param learn should we learn hostlist URLs from CORE
+ * @return #GNUNET_OK on success
  */
 int
 GNUNET_HOSTLIST_client_start (const struct GNUNET_CONFIGURATION_Handle *c,
                               struct GNUNET_STATISTICS_Handle *st,
                               GNUNET_CORE_ConnectEventHandler *ch,
                               GNUNET_CORE_DisconnectEventHandler *dh,
-                              GNUNET_CORE_MessageCallback *msgh, int learn)
+                              GNUNET_CORE_MessageCallback *msgh,
+                              int learn)
 {
   char *filename;
   char *proxytype_str;
@@ -1556,9 +1612,9 @@ GNUNET_HOSTLIST_client_start (const struct GNUNET_CONFIGURATION_Handle *c,
     load_hostlist_file ();
     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                 "Hostlists will be saved to file again in %s\n",
-                GNUNET_STRINGS_relative_time_to_string (SAVING_INTERVALL, GNUNET_YES));
+                GNUNET_STRINGS_relative_time_to_string (SAVING_INTERVAL, GNUNET_YES));
     ti_saving_task =
-        GNUNET_SCHEDULER_add_delayed (SAVING_INTERVALL, &task_hostlist_saving,
+        GNUNET_SCHEDULER_add_delayed (SAVING_INTERVAL, &task_hostlist_saving,
                                       NULL);
   }
   else
@@ -1636,7 +1692,7 @@ GNUNET_HOSTLIST_client_stop ()
     ti_check_download = GNUNET_SCHEDULER_NO_TASK;
     curl_global_cleanup ();
   }
-  if (transport != NULL)
+  if (NULL != transport)
   {
     GNUNET_TRANSPORT_disconnect (transport);
     transport = NULL;
@@ -1651,4 +1707,4 @@ GNUNET_HOSTLIST_client_stop ()
   cfg = NULL;
 }
 
-/* end of hostlist-client.c */
+/* end of gnunet-daemon-hostlist_client.c */
diff --git a/src/hostlist/hostlist-client.h b/src/hostlist/gnunet-daemon-hostlist_client.h
index 3def865e4..55f355649 100644
--- a/src/hostlist/hostlist-client.h
+++ b/src/hostlist/gnunet-daemon-hostlist_client.h
@@ -17,65 +17,17 @@
      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
      Boston, MA 02111-1307, USA.
 */
-
 /**
- * @file hostlist/hostlist-client.h
+ * @file hostlist/gnunet-daemon-hostlist_client.h
  * @brief hostlist support.  Downloads HELLOs via HTTP.
  * @author Christian Grothoff
  */
-
-#ifndef HOSTLIST_CLIENT_H
-#define HOSTLIST_CLIENT_H
+#ifndef GNUNET_DAEMON_HOSTLIST_CLIENT_H
+#define GNUNET_DAEMON_HOSTLIST_CLIENT_H
 
 #include "gnunet_core_service.h"
 #include "gnunet_statistics_service.h"
 #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
-
 
 
 /**
@@ -83,18 +35,19 @@
  *
  * @param c the configuration to use
  * @param st hande for publishing statistics
- * @param ch set to handler for connect notifications
- * @param dh set to handler for disconnect notifications
- * @param msgh set to handler for message handler notifications
+ * @param ch[OUT] set to handler for connect notifications
+ * @param dh[OUT] set to handler for disconnect notifications
+ * @param msgh[OUT] set to handler for message handler notifications
  * @param learn set if client is learning new hostlists
- * @return GNUNET_OK on success
+ * @return #GNUNET_OK on success
  */
 int
 GNUNET_HOSTLIST_client_start (const struct GNUNET_CONFIGURATION_Handle *c,
                               struct GNUNET_STATISTICS_Handle *st,
                               GNUNET_CORE_ConnectEventHandler *ch,
                               GNUNET_CORE_DisconnectEventHandler *dh,
-                              GNUNET_CORE_MessageCallback *msgh, int learn);
+                              GNUNET_CORE_MessageCallback *msgh,
+                              int learn);
 
 
 /**
@@ -105,4 +58,4 @@ GNUNET_HOSTLIST_client_stop (void);
 
 
 #endif
-/* end of hostlist-client.h */
+/* end of gnunet-daemon-hostlist_client.h */
diff --git a/src/hostlist/hostlist-server.c b/src/hostlist/gnunet-daemon-hostlist_server.c
index adf9359c6..8a7e747c6 100644
--- a/src/hostlist/hostlist-server.c
+++ b/src/hostlist/gnunet-daemon-hostlist_server.c
@@ -19,14 +19,15 @@
 */
 
 /**
- * @file hostlist/hostlist-server.c
- * @author Christian Grothoff, Matthias Wachs, David Barksdale
+ * @file hostlist/gnunet-daemon-hostlist_server.c
+ * @author Christian Grothoff
+ * @author Matthias Wachs
+ * @author David Barksdale
  * @brief application to provide an integrated hostlist HTTP server
  */
-
 #include "platform.h"
 #include <microhttpd.h>
-#include "hostlist-server.h"
+#include "gnunet-daemon-hostlist_server.h"
 #include "gnunet_hello_lib.h"
 #include "gnunet_peerinfo_service.h"
 #include "gnunet-daemon-hostlist.h"
@@ -34,6 +35,13 @@
 
 
 /**
+ * How long until our hostlist advertisment transmission via CORE should
+ * time out?
+ */
+#define GNUNET_ADV_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
+
+
+/**
  * Handle to the HTTP server as provided by libmicrohttpd for IPv6.
  */
 static struct MHD_Daemon *daemon_handle_v6;
@@ -148,7 +156,8 @@ finish_response ()
  * @return  #GNUNET_SYSERR to stop iterating (unless expiration has occured)
  */
 static int
-check_has_addr (void *cls, const struct GNUNET_HELLO_Address *address,
+check_has_addr (void *cls,
+                const struct GNUNET_HELLO_Address *address,
                 struct GNUNET_TIME_Absolute expiration)
 {
   int *arg = cls;
@@ -168,6 +177,11 @@ check_has_addr (void *cls, const struct GNUNET_HELLO_Address *address,
 /**
  * Callback that processes each of the known HELLOs for the
  * hostlist response construction.
+ *
+ * @param cls closure, NULL
+ * @param peer id of the peer, NULL for last call
+ * @param hello hello message for the peer (can be NULL)
+ * @param error message
  */
 static void
 host_processor (void *cls,
@@ -199,7 +213,10 @@ host_processor (void *cls,
   if (NULL == hello)
     return;
   has_addr = GNUNET_NO;
-  GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO, &check_has_addr, &has_addr);
+  GNUNET_HELLO_iterate_addresses (hello,
+                                  GNUNET_NO,
+                                  &check_has_addr,
+                                  &has_addr);
   if (GNUNET_NO == has_addr)
   {
     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
@@ -215,7 +232,9 @@ host_processor (void *cls,
   s = GNUNET_HELLO_size (hello);
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Received %u bytes of `%s' from peer `%s' for hostlist.\n",
-              (unsigned int) s, "HELLO", GNUNET_i2s (peer));
+              (unsigned int) s,
+              "HELLO",
+              GNUNET_i2s (peer));
   if ((old + s >= GNUNET_MAX_MALLOC_CHECKED) ||
       (old + s >= MAX_BYTES_PER_HOSTLISTS))
   {
@@ -226,19 +245,26 @@ host_processor (void *cls,
     return;                     /* too large, skip! */
   }
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-              "Adding peer `%s' to hostlist (%u bytes)\n", GNUNET_i2s (peer),
+              "Adding peer `%s' to hostlist (%u bytes)\n",
+              GNUNET_i2s (peer),
               (unsigned int) s);
   GNUNET_array_grow (builder->data, builder->size, old + s);
   memcpy (&builder->data[old], hello, s);
 }
 
 
-
 /**
  * Hostlist access policy (very permissive, allows everything).
+ * Returns #MHD_NO only if we are not yet ready to serve.
+ *
+ * @param cls closure
+ * @param addr address information from the client
+ * @param addrlen length of @a addr
+ * @return #MHD_YES if connection is allowed, #MHD_NO if not (we are not ready)
  */
 static int
-accept_policy_callback (void *cls, const struct sockaddr *addr,
+accept_policy_callback (void *cls,
+                        const struct sockaddr *addr,
                         socklen_t addrlen)
 {
   if (NULL == response)
@@ -254,9 +280,11 @@ accept_policy_callback (void *cls, const struct sockaddr *addr,
 /**
  * Add headers to a request indicating that we allow Cross-Origin Resource
  * Sharing.
+ *
+ * @param response response to add headers to
  */
 static void
-add_cors_headers(struct MHD_Response *response)
+add_cors_headers (struct MHD_Response *response)
 {
   MHD_add_response_header (response,
                            "Access-Control-Allow-Origin",
@@ -272,12 +300,47 @@ add_cors_headers(struct MHD_Response *response)
 
 /**
  * Main request handler.
+ *
+ * @param cls argument given together with the function
+ *        pointer when the handler was registered with MHD
+ * @param url the requested url
+ * @param method the HTTP method used (#MHD_HTTP_METHOD_GET,
+ *        #MHD_HTTP_METHOD_PUT, etc.)
+ * @param version the HTTP version string (i.e.
+ *        #MHD_HTTP_VERSION_1_1)
+ * @param upload_data the data being uploaded (excluding HEADERS,
+ *        for a POST that fits into memory and that is encoded
+ *        with a supported encoding, the POST data will NOT be
+ *        given in upload_data and is instead available as
+ *        part of #MHD_get_connection_values; very large POST
+ *        data *will* be made available incrementally in
+ *        @a upload_data)
+ * @param upload_data_size set initially to the size of the
+ *        @a upload_data provided; the method must update this
+ *        value to the number of bytes NOT processed;
+ * @param con_cls pointer that the callback can set to some
+ *        address and that will be preserved by MHD for future
+ *        calls for this request; since the access handler may
+ *        be called many times (i.e., for a PUT/POST operation
+ *        with plenty of upload data) this allows the application
+ *        to easily associate some request-specific state.
+ *        If necessary, this state can be cleaned up in the
+ *        global #MHD_RequestCompletedCallback (which
+ *        can be set with the #MHD_OPTION_NOTIFY_COMPLETED).
+ *        Initially, `*con_cls` will be NULL.
+ * @return #MHD_YES if the connection was handled successfully,
+ *         #MHD_NO if the socket must be closed due to a serios
+ *         error while handling the request
  */
 static int
-access_handler_callback (void *cls, struct MHD_Connection *connection,
-                         const char *url, const char *method,
-                         const char *version, const char *upload_data,
-                         size_t * upload_data_size, void **con_cls)
+access_handler_callback (void *cls,
+                         struct MHD_Connection *connection,
+                         const char *url,
+                         const char *method,
+                         const char *version,
+                         const char *upload_data,
+                         size_t *upload_data_size,
+                         void **con_cls)
 {
   static int dummy;
 
@@ -343,13 +406,17 @@ access_handler_callback (void *cls, struct MHD_Connection *connection,
 
 
 /**
- * Handler called by core when core is ready to transmit message
- * @param cls   closure
- * @param size  size of buffer to copy message to
- * @param buf   buffer to copy message to
+ * Handler called by CORE when CORE is ready to transmit message
+ *
+ * @param cls closure
+ * @param size size of buffer to copy message to
+ * @param buf buffer to copy message to
+ * @return number of bytes copied to @a buf
  */
 static size_t
-adv_transmit_ready (void *cls, size_t size, void *buf)
+adv_transmit_ready (void *cls,
+                    size_t size,
+                    void *buf)
 {
   static uint64_t hostlist_adv_count;
   size_t transmission_size;
@@ -391,7 +458,8 @@ adv_transmit_ready (void *cls, size_t size, void *buf)
  * @param peer peer identity this notification is about
  */
 static void
-connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
+connect_handler (void *cls,
+                 const struct GNUNET_PeerIdentity *peer)
 {
   size_t size;
 
@@ -413,12 +481,15 @@ connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
     return;
   }
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-              "Asked core to transmit advertisement message with a size of %u bytes to peer `%s'\n",
-              size, GNUNET_i2s (peer));
+              "Asked CORE to transmit advertisement message with a size of %u bytes to peer `%s'\n",
+              size,
+              GNUNET_i2s (peer));
   if (NULL ==
       GNUNET_CORE_notify_transmit_ready (core, GNUNET_YES,
                                          GNUNET_CORE_PRIO_BEST_EFFORT,
-                                         GNUNET_ADV_TIMEOUT, peer, size,
+                                         GNUNET_ADV_TIMEOUT,
+                                         peer,
+                                         size,
                                          &adv_transmit_ready, NULL))
   {
     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
@@ -434,7 +505,8 @@ connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
  * @param peer peer identity this notification is about
  */
 static void
-disconnect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
+disconnect_handler (void *cls,
+                    const struct GNUNET_PeerIdentity *peer)
 {
   /* nothing to do */
 }
@@ -450,8 +522,10 @@ disconnect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
  * @param err_msg NULL if successful, otherwise contains error message
  */
 static void
-process_notify (void *cls, const struct GNUNET_PeerIdentity *peer,
-                const struct GNUNET_HELLO_Message *hello, const char *err_msg)
+process_notify (void *cls,
+                const struct GNUNET_PeerIdentity *peer,
+                const struct GNUNET_HELLO_Message *hello,
+                const char *err_msg)
 {
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Peerinfo is notifying us to rebuild our hostlist\n");
@@ -489,9 +563,13 @@ prepare_daemon (struct MHD_Daemon *daemon_handle);
 /**
  * Call MHD to process pending requests and then go back
  * and schedule the next run.
+ *
+ * @param cls the `struct MHD_Daemon` of the HTTP server to run
+ * @param tc scheduler context
  */
 static void
-run_daemon (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+run_daemon (void *cls,
+            const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct MHD_Daemon *daemon_handle = cls;
 
@@ -513,6 +591,8 @@ run_daemon (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 /**
  * Function that queries MHD's select sets and
  * starts the task waiting for them.
+ *
+ * @param daemon_handle HTTP server to prepare to run
  */
 static GNUNET_SCHEDULER_TaskIdentifier
 prepare_daemon (struct MHD_Daemon *daemon_handle)
@@ -555,6 +635,12 @@ prepare_daemon (struct MHD_Daemon *daemon_handle)
 /**
  * Start server offering our hostlist.
  *
+ * @param c configuration to use
+ * @param st statistics handle to use
+ * @param co core handle to use
+ * @param server_ch[OUT] set to handler for CORE connect events
+ * @param server_dh[OUT] set to handler for CORE disconnect events
+ * @param advertise #GNUNET_YES if we should advertise our hostlist
  * @return #GNUNET_OK on success
  */
 int
@@ -799,4 +885,4 @@ GNUNET_HOSTLIST_server_stop ()
   core = NULL;
 }
 
-/* end of hostlist-server.c */
+/* end of gnunet-daemon-hostlist_server.c */
diff --git a/src/hostlist/hostlist-server.h b/src/hostlist/gnunet-daemon-hostlist_server.h
index e0f8eb4a6..bfceda336 100644
--- a/src/hostlist/hostlist-server.h
+++ b/src/hostlist/gnunet-daemon-hostlist_server.h
@@ -19,24 +19,29 @@
 */
 
 /**
- * @file hostlist/hostlist-server.h
+ * @file hostlist/gnunet-daemon-hostlist_server.h
  * @brief hostlist support.  Downloads HELLOs via HTTP.
  * @author Christian Grothoff
  */
 
-#ifndef HOSTLIST_SERVER_H
-#define HOSTLIST_SERVER_H
+#ifndef GNUNET_DAEMON_HOSTLIST_SERVER_H
+#define GNUNET_DAEMON_HOSTLIST_SERVER_H
 
 #include "gnunet_core_service.h"
 #include "gnunet_statistics_service.h"
 #include "gnunet_util_lib.h"
 
-#define GNUNET_ADV_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
 
 /**
  * Start server offering our hostlist.
  *
- * @return GNUNET_OK on success
+ * @param c configuration to use
+ * @param st statistics handle to use
+ * @param co core handle to use
+ * @param server_ch[OUT] set to handler for CORE connect events
+ * @param server_dh[OUT] set to handler for CORE disconnect events
+ * @param advertise #GNUNET_YES if we should advertise our hostlist
+ * @return #GNUNET_OK on success
  */
 int
 GNUNET_HOSTLIST_server_start (const struct GNUNET_CONFIGURATION_Handle *c,
@@ -55,4 +60,4 @@ GNUNET_HOSTLIST_server_stop (void);
 
 
 #endif
-/* end of hostlist-server.h */
+/* end of gnunet-daemon-hostlist_server.h */
diff --git a/src/hostlist/test_gnunet_daemon_hostlist_learning.c b/src/hostlist/test_gnunet_daemon_hostlist_learning.c
index 8a5cdac7a..9f4d8e3d7 100644
--- a/src/hostlist/test_gnunet_daemon_hostlist_learning.c
+++ b/src/hostlist/test_gnunet_daemon_hostlist_learning.c
@@ -37,7 +37,7 @@
  */
 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 180)
 
-#define CHECK_INTERVALL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
+#define CHECK_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
 
 
 struct PeerContext
@@ -304,7 +304,7 @@ check_statistics (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
                                &process_adv_sent, NULL);
   }
   check_task =
-      GNUNET_SCHEDULER_add_delayed (CHECK_INTERVALL, &check_statistics, NULL);
+      GNUNET_SCHEDULER_add_delayed (CHECK_INTERVAL, &check_statistics, NULL);
 }
 
 
@@ -452,7 +452,7 @@ run (void *cls, char *const *args, const char *cfgfile,
   timeout_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &timeout_error, NULL);
 
   check_task =
-      GNUNET_SCHEDULER_add_delayed (CHECK_INTERVALL, &check_statistics, NULL);
+      GNUNET_SCHEDULER_add_delayed (CHECK_INTERVAL, &check_statistics, NULL);
 }