no valgrind
[oweals/gnunet.git] / src / experimentation / gnunet-daemon-experimentation_capabilities.c
index 74220435afd38ec000d08abb1534d05cac246c8d..6d8396b96217dce4051eb33f57534e5dd2abb603 100644 (file)
 #include "gnunet_statistics_service.h"
 #include "gnunet-daemon-experimentation.h"
 
+
+/**
+ * Capability value shared between components
+ */
 uint32_t GSE_node_capabilities;
 
 
+/**
+ * Capabilities defined at the moment
+ */
 #define GNUNET_EXPERIMENTATION_capabilities_count 11;
 
+
 /**
  * Capabilities a node has or an experiment requires string
  */
 #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 +80,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 +100,6 @@ GNUNET_EXPERIMENTATION_capabilities_have (uint32_t have, uint32_t desired)
 
 /**
  * Start the detecting capabilities
- *
- * @param cfg configuration handle
  */
 void
 GNUNET_EXPERIMENTATION_capabilities_start ()
@@ -145,6 +160,7 @@ GNUNET_EXPERIMENTATION_capabilities_start ()
   }
 }
 
+
 /**
  * Stop the detecting capabilities
  */