missing changes to headers
[oweals/gnunet.git] / src / include / gnunet_nse_service.h
index a0c6016a40a537189d95016cbb858afc8c18e9cd..4e4c10987dfdabee1ef7325f8b34bcd7e5b229b8 100644 (file)
@@ -1,10 +1,10 @@
 /*
       This file is part of GNUnet
-      (C) 2011 Christian Grothoff (and other contributing authors)
+      Copyright (C) 2011 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
-      by the Free Software Foundation; either version 2, or (at your
+      by the Free Software Foundation; either version 3, or (at your
       option) any later version.
 
       GNUnet is distributed in the hope that it will be useful, but
@@ -14,8 +14,8 @@
 
       You should have received a copy of the GNU General Public License
       along with GNUnet; see the file COPYING.  If not, write to the
-      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-      Boston, MA 02111-1307, USA.
+      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+      Boston, MA 02110-1301, USA.
  */
 
 #ifndef GNUNET_NSE_SERVICE_H_
@@ -26,8 +26,9 @@
  * @brief API to retrieve the current network size estimate,
  *        also to register for notifications whenever a new
  *        network size estimate is calculated.
- *
  * @author Nathan Evans
+ * @defgroup nse network size estimation service
+ * @{
  */
 
 #ifdef __cplusplus
@@ -38,9 +39,7 @@ extern "C"
 #endif
 #endif
 
-#include "gnunet_common.h"
-#include "gnunet_configuration_lib.h"
-#include "gnunet_scheduler_lib.h"
+#include "gnunet_util_lib.h"
 
 /**
  * Version of the network size estimation API.
@@ -75,14 +74,14 @@ typedef void (*GNUNET_NSE_Callback) (void *cls,
  */
 #define GNUNET_NSE_log_estimate_to_n(loge) pow(2.0, (loge))
 
+
 /**
  * Connect to the network size estimation service.
  *
  * @param cfg the configuration to use
  * @param func funtion to call with network size estimate
- * @param func_cls closure to pass for network size estimate callback
- *
- * @return handle to use
+ * @param func_cls closure to pass to @a func
+ * @return handle to use in #GNUNET_NSE_disconnect to stop NSE from invoking the callbacks
  */
 struct GNUNET_NSE_Handle *
 GNUNET_NSE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
@@ -93,7 +92,6 @@ GNUNET_NSE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
  * Disconnect from network size estimation service
  *
  * @param h handle to destroy
- *
  */
 void
 GNUNET_NSE_disconnect (struct GNUNET_NSE_Handle *h);
@@ -106,4 +104,6 @@ GNUNET_NSE_disconnect (struct GNUNET_NSE_Handle *h);
 }
 #endif
 
+/** @} */ /* end of group nse */
+
 #endif /* GNUNET_NSE_SERVICE_H_ */