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

[gnunet]

Author: wachs
Date: 2013-06-21 15:40:48 +0200 (Fri, 21 Jun 2013)
New Revision: 27510

Modified:
   gnunet/src/ats/gnunet-service-ats-solver_mlp.c
   gnunet/src/ats/gnunet-service-ats-solver_mlp.h
   gnunet/src/ats/gnunet-service-ats-solver_proportional.c
   gnunet/src/ats/gnunet-service-ats-solver_proportional.h
   gnunet/src/ats/gnunet-service-ats_normalization.c
   gnunet/src/ats/gnunet-service-ats_normalization.h
Log:
doxygen fixes


Modified: gnunet/src/ats/gnunet-service-ats-solver_mlp.c
===================================================================
--- gnunet/src/ats/gnunet-service-ats-solver_mlp.c      2013-06-21 13:16:22 UTC 
(rev 27509)
+++ gnunet/src/ats/gnunet-service-ats-solver_mlp.c      2013-06-21 13:40:48 UTC 
(rev 27510)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file ats/gnunet-service-ats_addresses_mlp.c
+ * @file ats/gnunet-service-ats-solver_mlp.c
  * @brief ats mlp problem solver
  * @author Matthias Wachs
  * @author Christian Grothoff
@@ -1630,6 +1630,8 @@
  * @param dest_length array length for quota arrays
  * @param bw_changed_cb callback for changed bandwidth amounts
  * @param bw_changed_cb_cls cls for callback
+ * @param get_preference callback to get relative preferences for a peer
+ * @param get_preference_cls cls for callback to get relative preferences
  * @return struct GAS_MLP_Handle on success, NULL on fail
  */
 void *

Modified: gnunet/src/ats/gnunet-service-ats-solver_mlp.h
===================================================================
--- gnunet/src/ats/gnunet-service-ats-solver_mlp.h      2013-06-21 13:16:22 UTC 
(rev 27509)
+++ gnunet/src/ats/gnunet-service-ats-solver_mlp.h      2013-06-21 13:40:48 UTC 
(rev 27510)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file ats/gnunet-service-ats_addresses_mlp.h
+ * @file ats/gnunet-service-ats-solver_mlp.h
  * @brief ats MLP problem solver
  * @author Matthias Wachs
  * @author Christian Grothoff
@@ -345,7 +345,7 @@
 /**
  * Init the MLP problem solving component
  *
- * @param cfg configuration handle
+ * @param cfg the GNUNET_CONFIGURATION_Handle handle
  * @param stats the GNUNET_STATISTICS handle
  * @param network array of GNUNET_ATS_NetworkType with length dest_length
  * @param out_dest array of outbound quotas
@@ -353,6 +353,8 @@
  * @param dest_length array length for quota arrays
  * @param bw_changed_cb callback for changed bandwidth amounts
  * @param bw_changed_cb_cls cls for callback
+ * @param get_preference callback to get relative preferences for a peer
+ * @param get_preference_cls cls for callback to get relative preferences
  * @return struct GAS_MLP_Handle on success, NULL on fail
  */
 void *

Modified: gnunet/src/ats/gnunet-service-ats-solver_proportional.c
===================================================================
--- gnunet/src/ats/gnunet-service-ats-solver_proportional.c     2013-06-21 
13:16:22 UTC (rev 27509)
+++ gnunet/src/ats/gnunet-service-ats-solver_proportional.c     2013-06-21 
13:40:48 UTC (rev 27510)
@@ -1225,6 +1225,8 @@
  * @param dest_length array length for quota arrays
  * @param bw_changed_cb callback for changed bandwidth amounts
  * @param bw_changed_cb_cls cls for callback
+ * @param get_preference callback to get relative preferences for a peer
+ * @param get_preference_cls cls for callback to get relative preferences
  * @return handle for the solver on success, NULL on fail
  */
 void *

Modified: gnunet/src/ats/gnunet-service-ats-solver_proportional.h
===================================================================
--- gnunet/src/ats/gnunet-service-ats-solver_proportional.h     2013-06-21 
13:16:22 UTC (rev 27509)
+++ gnunet/src/ats/gnunet-service-ats-solver_proportional.h     2013-06-21 
13:40:48 UTC (rev 27510)
@@ -73,6 +73,8 @@
  * @param dest_length array length for quota arrays
  * @param bw_changed_cb callback for changed bandwidth amounts
  * @param bw_changed_cb_cls cls for callback
+ * @param get_preference callback to get relative preferences for a peer
+ * @param get_preference_cls cls for callback to get relative preferences
  * @return handle for the solver on success, NULL on fail
  */
 void *

Modified: gnunet/src/ats/gnunet-service-ats_normalization.c
===================================================================
--- gnunet/src/ats/gnunet-service-ats_normalization.c   2013-06-21 13:16:22 UTC 
(rev 27509)
+++ gnunet/src/ats/gnunet-service-ats_normalization.c   2013-06-21 13:40:48 UTC 
(rev 27510)
@@ -169,7 +169,8 @@
 /**
  * Update a peer
  * @param id peer id
- * @pram kind the kind
+ * @param kind the kind
+ * @return the new relative preference
  */
 static double
 update_peers (struct GNUNET_PeerIdentity *id,
@@ -307,8 +308,10 @@
 
 /**
  * Update the absolute preference value for a peer
- * @param id peer id
- * @param kind the kind
+ * @param c the client
+ * @param p the peer
+ * @param kind the preference kind
+ * @param score_abs the absolute value
  * @return the new relative preference value
  */
 static double
@@ -489,7 +492,7 @@
  * Start the normalization component
  *
  * @param pref_ch_cb callback to call on relative preference changing
- * @param ref_ch_cb_cls cls for the callback
+ * @param pref_ch_cb_cls cls for the callback
  */
 void
 GAS_normalization_start (GAS_Normalization_preference_changed_cb pref_ch_cb,

Modified: gnunet/src/ats/gnunet-service-ats_normalization.h
===================================================================
--- gnunet/src/ats/gnunet-service-ats_normalization.h   2013-06-21 13:16:22 UTC 
(rev 27509)
+++ gnunet/src/ats/gnunet-service-ats_normalization.h   2013-06-21 13:40:48 UTC 
(rev 27510)
@@ -68,7 +68,7 @@
  * Start the normalization component
  *
  * @param pref_ch_cb callback to call on relative preference changing
- * @param ref_ch_cb_cls cls for the callback
+ * @param pref_ch_cb_cls cls for the callback
  */
 void
 GAS_normalization_start (GAS_Normalization_preference_changed_cb pref_ch_cb, 
void *pref_ch_cb_cls);