[GNUnet-SVN] r25237 - gnunet/src/ats

[gnunet]

Author: wachs
Date: 2012-12-04 16:26:28 +0100 (Tue, 04 Dec 2012)
New Revision: 25237

Modified:
   gnunet/src/ats/gnunet-service-ats_addresses_mlp.c
   gnunet/src/ats/gnunet-service-ats_addresses_mlp.h
Log:
doxygen

Modified: gnunet/src/ats/gnunet-service-ats_addresses_mlp.c
===================================================================
--- gnunet/src/ats/gnunet-service-ats_addresses_mlp.c   2012-12-04 15:20:41 UTC 
(rev 25236)
+++ gnunet/src/ats/gnunet-service-ats_addresses_mlp.c   2012-12-04 15:26:28 UTC 
(rev 25237)
@@ -930,7 +930,7 @@
   return GNUNET_OK;
 }
 
-int GAS_mlp_solve_problem (struct GAS_MLP_Handle *mlp, struct 
GAS_MLP_SolutionContext *ctx);
+int GAS_mlp_solve_problem (void *solver, struct GAS_MLP_SolutionContext *ctx);
 
 
 static void
@@ -954,13 +954,14 @@
 /**
  * Solves the MLP problem
  *
- * @param mlp the MLP Handle
+ * @param solver the MLP Handle
  * @param ctx solution context
  * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
  */
 int
-GAS_mlp_solve_problem (struct GAS_MLP_Handle *mlp, struct 
GAS_MLP_SolutionContext *ctx)
+GAS_mlp_solve_problem (void *solver, struct GAS_MLP_SolutionContext *ctx)
 {
+  struct GAS_MLP_Handle *mlp = solver;
   int res;
   /* Check if solving is already running */
   if (GNUNET_YES == mlp->semaphore)
@@ -1069,9 +1070,7 @@
  *
  * @param cfg the GNUNET_CONFIGURATION_Handle handle
  * @param stats the GNUNET_STATISTICS handle
- * @param max_duration maximum numbers of iterations for the LP/MLP Solver
- * @param max_iterations maximum time limit for the LP/MLP Solver
- * @return struct GAS_MLP_Handle * on success, NULL on fail
+ * @return struct GAS_MLP_Handle on success, NULL on fail
  */
 void *
 GAS_mlp_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
@@ -1521,7 +1520,7 @@
  * Otherwise the addresses' values can be updated and the existing base can
  * be reused
  *
- * @param mlp the MLP Handle
+ * @param solver the MLP Handle
  * @param addresses the address hashmap
  *        the address has to be already removed from the hashmap
  * @param address the address to update
@@ -1625,7 +1624,7 @@
  *
  * The MLP problem has to be recreated and the problem has to be resolved
  *
- * @param mlp the MLP Handle
+ * @param solver the MLP Handle
  * @param addresses the address hashmap
  *        the address has to be already removed from the hashmap
  * @param address the address to delete
@@ -1707,7 +1706,7 @@
 /**
  * Get the preferred address for a specific peer
  *
- * @param mlp the MLP Handle
+ * @param solver the MLP Handle
  * @param addresses address hashmap
  * @param peer the peer
  * @return suggested address
@@ -1730,7 +1729,7 @@
 /**
  * Changes the preferences for a peer in the MLP problem
  *
- * @param mlp the MLP Handle
+ * @param solver the MLP Handle
  * @param peer the peer
  * @param kind the kind to change the preference
  * @param score the score
@@ -1752,7 +1751,8 @@
 
 /**
  * Shutdown the MLP problem solving component
- * @param mlp the MLP handle
+ *
+ * @param solver the solver handle
  */
 void
 GAS_mlp_done (void *solver)

Modified: gnunet/src/ats/gnunet-service-ats_addresses_mlp.h
===================================================================
--- gnunet/src/ats/gnunet-service-ats_addresses_mlp.h   2012-12-04 15:20:41 UTC 
(rev 25236)
+++ gnunet/src/ats/gnunet-service-ats_addresses_mlp.h   2012-12-04 15:26:28 UTC 
(rev 25237)
@@ -20,7 +20,7 @@
 
 /**
  * @file ats/gnunet-service-ats_addresses_mlp.h
- * @brief ats mlp problem solver
+ * @brief ats MLP problem solver
  * @author Matthias Wachs
  * @author Christian Grothoff
  */
@@ -34,8 +34,6 @@
 #ifndef GNUNET_SERVICE_ATS_ADDRESSES_MLP_H
 #define GNUNET_SERVICE_ATS_ADDRESSES_MLP_H
 
-#define DEBUG_MLP GNUNET_EXTRA_LOGGING
-
 #define BIG_M_VALUE (UINT32_MAX) /10
 #define BIG_M_STRING "unlimited"
 
@@ -317,25 +315,13 @@
  *
  * @param cfg configuration handle
  * @param stats the GNUNET_STATISTICS handle
- * @param max_duration maximum numbers of iterations for the LP/MLP Solver
- * @param max_iterations maximum time limit for the LP/MLP Solver
- * @return struct GAS_MLP_Handle * on success, NULL on fail
+ * @return struct GAS_MLP_Handle on success, NULL on fail
  */
 void *
 GAS_mlp_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
               const struct GNUNET_STATISTICS_Handle *stats);
 
-/**
- * Solves the MLP problem on demand
- *
- * @param mlp the MLP Handle
- * @param ctx solution context
- * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
- */
-int
-GAS_mlp_solve_problem (struct GAS_MLP_Handle *mlp, struct 
GAS_MLP_SolutionContext *ctx);
 
-
 /**
  * Updates a single address in the MLP problem
  *
@@ -345,7 +331,7 @@
  * Otherwise the addresses' values can be updated and the existing base can
  * be reused
  *
- * @param mlp the MLP Handle
+ * @param solver the MLP Handle
  * @param addresses the address hashmap
  *        the address has to be already added from the hashmap
  * @param address the address to update
@@ -361,19 +347,21 @@
  *
  * The MLP problem has to be recreated and the problem has to be resolved
  *
- * @param mlp the MLP Handle
+ * @param solver the MLP Handle
  * @param addresses the address hashmap
  *        the address has to be already removed from the hashmap
  * @param address the address to delete
  */
 void
-GAS_mlp_address_delete (void *solver, struct GNUNET_CONTAINER_MultiHashMap * 
addresses, struct ATS_Address *address);
+GAS_mlp_address_delete (void *solver,
+                        struct GNUNET_CONTAINER_MultiHashMap *addresses,
+                        struct ATS_Address *address);
 
 
 /**
  * Changes the preferences for a peer in the MLP problem
  *
- * @param mlp the MLP Handle
+ * @param solver the MLP Handle
  * @param peer the peer
  * @param kind the kind to change the preference
  * @param score the score
@@ -388,7 +376,7 @@
 /**
  * Get the preferred address for a specific peer
  *
- * @param mlp the MLP Handle
+ * @param solver the MLP Handle
  * @param addresses address hashmap
  * @param peer the peer
  * @return suggested address
@@ -400,6 +388,8 @@
 
 /**
  * Shutdown the MLP problem solving component
+ *
+ * @param solver the solver handle
  */
 void
 GAS_mlp_done (void *solver);