[GNUnet-SVN] r30023 - gnunet/src/include

[gnunet]

Author: wachs
Date: 2013-10-09 09:33:47 +0200 (Wed, 09 Oct 2013)
New Revision: 30023

Modified:
   gnunet/src/include/gnunet_ats_plugin.h
Log:
documentation and fix for const warning


Modified: gnunet/src/include/gnunet_ats_plugin.h
===================================================================
--- gnunet/src/include/gnunet_ats_plugin.h      2013-10-09 01:30:25 UTC (rev 
30022)
+++ gnunet/src/include/gnunet_ats_plugin.h      2013-10-09 07:33:47 UTC (rev 
30023)
@@ -291,9 +291,9 @@
 
 
 /**
- * The transport service will pass a pointer to a struct
+ * The ATS service will pass a pointer to a struct
  * of this type as the first and only argument to the
- * entry point of each transport plugin.
+ * entry point of each ATS solver.
  */
 struct GNUNET_ATS_PluginEnvironment
 {
@@ -302,26 +302,89 @@
    */
   void *cls;
 
+
+  /**
+   * Configuration handle to be used by the solver
+   */
+  const struct GNUNET_CONFIGURATION_Handle *cfg;
+
+
+  /**
+   * Statistics handle to be used by the solver
+   */
+  const struct GNUNET_STATISTICS_Handle *stats;
+
+
+  /**
+   * Hashmap containing all addresses available
+   */
+  struct GNUNET_CONTAINER_MultiPeerMap *addresses;
+
+
+  /**
+   * ATS addresses callback to be notified about bandwidth assignment changes
+   */
   GAS_bandwidth_changed_cb bandwidth_changed_cb;
+
+
+  /**
+   * ATS addresses closure to be notified about bandwidth assignment changes
+   */
   void *bw_changed_cb_cls;
 
-  GAS_get_preferences get_preferences_cb;
+
+  /**
+   * ATS addresses function to obtain preference values
+   */
+  GAS_get_preferences get_preferences;
+
+
+  /**
+   * ATS addresses function closure to obtain preference values
+   */
   void *get_preference_cls;
 
+  /**
+   * ATS addresses function to obtain property values
+   */
   GAS_get_properties get_property_cb;
+
+
+  /**
+   * ATS addresses function closure to obtain property values
+   */
   void *get_property_cls;
 
+
+  /**
+   * The ATS solver plugin functions to call
+   */
   struct GNUNET_ATS_SolverFunctions sf;
 
-  struct GNUNET_CONFIGURATION_Handle *cfg;
-  struct GNUNET_STATISTICS_Handle *stats;
-  struct GNUNET_CONTAINER_MultiPeerMap *addresses;
 
-  /* Available networks */
+  /**
+   *  Available networks
+   */
   int networks[GNUNET_ATS_NetworkTypeCount];
+
+
+  /**
+   * Number of networks available
+   */
   int network_count;
 
+
+  /**
+   * Array of configured outbound quotas
+   * Order according to networks in network array
+   */
   unsigned long long out_quota[GNUNET_ATS_NetworkTypeCount];
+
+
+  /**
+   * Array of configured inbound quotas
+   * Order according to networks in network array
+   */
   unsigned long long in_quota[GNUNET_ATS_NetworkTypeCount];
 };