From 4456c3907fd3b463a204a986245680ce96425c10 Mon Sep 17 00:00:00 2001
From: Matthias Wachs <wachs@net.in.tum.de>
Date: Mon, 27 May 2013 08:09:35 +0000
Subject: [PATCH] documentation

---
 .../gnunet-daemon-experimentation.c           | 12 ++++++--
 .../gnunet-daemon-experimentation.h           | 30 ++++++++++++++++++-
 ...unet-daemon-experimentation_capabilities.c | 13 ++++++--
 3 files changed, 49 insertions(+), 6 deletions(-)

diff --git a/src/experimentation/gnunet-daemon-experimentation.c b/src/experimentation/gnunet-daemon-experimentation.c
index 78177f59c..ee632ec86 100644
--- a/src/experimentation/gnunet-daemon-experimentation.c
+++ b/src/experimentation/gnunet-daemon-experimentation.c
@@ -31,12 +31,21 @@
 #include "gnunet_statistics_service.h"
 #include "gnunet-daemon-experimentation.h"
 
+
+/**
+ * Statistics handle shared between components
+ */
 struct GNUNET_STATISTICS_Handle *GSE_stats;
 
+
+/**
+ * Configuration handle shared between components
+ */
 struct GNUNET_CONFIGURATION_Handle *GSE_cfg;
 
+
 /**
- * Task run during shutdown.
+ * Task run during shutdown to stop all submodules of the experimentation daemon.
  *
  * @param cls unused
  * @param tc unused
@@ -51,7 +60,6 @@ shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 }
 
 
-
 /**
  * Function starting all submodules of the experimentation daemon.
  *
diff --git a/src/experimentation/gnunet-daemon-experimentation.h b/src/experimentation/gnunet-daemon-experimentation.h
index d7508f9fc..d2fc6bd37 100644
--- a/src/experimentation/gnunet-daemon-experimentation.h
+++ b/src/experimentation/gnunet-daemon-experimentation.h
@@ -36,12 +36,25 @@
  */
 #define EXP_RESPONSE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
 
+
+/**
+ * Statistics handle shared between components
+ */
 extern struct GNUNET_STATISTICS_Handle *GSE_stats;
 
+
+/**
+ * Configuration handle shared between components
+ */
 extern struct GNUNET_CONFIGURATION_Handle *GSE_cfg;
 
+
+/**
+ * Capability value shared between components
+ */
 extern uint32_t GSE_node_capabilities;
 
+
 /**
  * Capabilities a node has or an experiment requires
  */
@@ -120,21 +133,35 @@ GNUNET_EXPERIMENTATION_nodes_start ();
 void
 GNUNET_EXPERIMENTATION_nodes_stop ();
 
+
+/**
+ * Print a single capability value
+ *
+ * @param cap capability value
+ * @return the string to print
+ */
+const char *
+GNUNET_EXPERIMENTATION_capability_to_str (uint32_t cap);
+
+
 /**
  * Are the capabilities provided?
  *
  * @param have bitstring containing the provided capabilities
- * @param have bitstring containing the desired capabilities
+ * @param desired bitstring containing the desired capabilities\
+ * @return GNUNET_YES or GNUNET_NO
  */
 int
 GNUNET_EXPERIMENTATION_capabilities_have (uint32_t have, uint32_t desired);
 
+
 /**
  * Start the detecting capabilities
  */
 void
 GNUNET_EXPERIMENTATION_capabilities_start ();
 
+
 /**
  * Stop the detecting capabilities
  */
@@ -159,6 +186,7 @@ GNUNET_EXPERIMENTATION_experiments_issuer_accepted (struct GNUNET_PeerIdentity *
 int
 GNUNET_EXPERIMENTATION_experiments_start ();
 
+
 /**
  * Stop experiments management
  */
diff --git a/src/experimentation/gnunet-daemon-experimentation_capabilities.c b/src/experimentation/gnunet-daemon-experimentation_capabilities.c
index 74220435a..c888db019 100644
--- a/src/experimentation/gnunet-daemon-experimentation_capabilities.c
+++ b/src/experimentation/gnunet-daemon-experimentation_capabilities.c
@@ -41,6 +41,13 @@ uint32_t GSE_node_capabilities;
  */
 #define GNUNET_EXPERIMENTATION_capabilities_string {"NONE", "PLUGIN_TCP", "PLUGIN_UDP", "PLUGIN_UNIX", "PLUGIN_HTTP_CLIENT", "PLUGIN_HTTP_SERVER", "PLUGIN_HTTPS_CLIENT", "PLUGIN_HTTPS_SERVER", "PLUGIN_WLAN", "HAVE_IPV6", "BEHIND_NAT"}
 
+
+/**
+ * Print a single capability value
+ *
+ * @param cap capability value
+ * @return the string to print
+ */
 const char *
 GNUNET_EXPERIMENTATION_capability_to_str (uint32_t cap)
 {
@@ -65,11 +72,13 @@ GNUNET_EXPERIMENTATION_capability_to_str (uint32_t cap)
 
 }
 
+
 /**
  * Are the capabilities provided?
  *
  * @param have bitstring containing the provided capabilities
- * @param have bitstring containing the desired capabilities
+ * @param desired bitstring containing the desired capabilities\
+ * @return GNUNET_YES or GNUNET_NO
  */
 int
 GNUNET_EXPERIMENTATION_capabilities_have (uint32_t have, uint32_t desired)
@@ -83,8 +92,6 @@ GNUNET_EXPERIMENTATION_capabilities_have (uint32_t have, uint32_t desired)
 
 /**
  * Start the detecting capabilities
- *
- * @param cfg configuration handle
  */
 void
 GNUNET_EXPERIMENTATION_capabilities_start ()
-- 
2.25.1