[GNUnet-SVN] r32705 - in gnunet/src: ats ats-tests transport

[gnunet]

Author: wachs
Date: 2014-03-20 11:42:14 +0100 (Thu, 20 Mar 2014)
New Revision: 32705

Modified:
   gnunet/src/ats-tests/ats-testing-log.c
   gnunet/src/ats-tests/ats-testing-preferences.c
   gnunet/src/ats-tests/ats-testing.c
   gnunet/src/ats-tests/ats-testing.h
   gnunet/src/ats/gnunet-ats-solver-eval.c
   gnunet/src/ats/plugin_ats_ril.c
   gnunet/src/transport/gnunet-service-transport_plugins.c
   gnunet/src/transport/gnunet-service-transport_plugins.h
Log:
doxygen fixes


Modified: gnunet/src/ats/gnunet-ats-solver-eval.c
===================================================================
--- gnunet/src/ats/gnunet-ats-solver-eval.c     2014-03-20 10:42:04 UTC (rev 
32704)
+++ gnunet/src/ats/gnunet-ats-solver-eval.c     2014-03-20 10:42:14 UTC (rev 
32705)
@@ -374,17 +374,20 @@
 
 
 /**
- * Generate between the source master and the partner and set preferences with 
a
+ * Generate between the source master and the partner and set property with a
  * value depending on the generator.
  *
- * @param src source
- * @param dest partner
- * @param type type of preferences to generate
- * @param base_rate traffic base rate to send data with
- * @param max_rate  traffic maximum rate to send data with
- * @param period duration of a period of traffic generation (~ 1/frequency)
- * @param duration how long to generate traffic
- * @return the traffic generator
+ * @param peer source
+ * @param address_id partner
+ * @param test_peer the peer
+ * @param test_address the address
+ * @param type type of generator
+ * @param base_value base value
+ * @param value_rate maximum value
+ * @param period duration of a period of generation (~ 1/frequency)
+ * @param frequency how long to generate property
+ * @param ats_property ATS property to generate
+ * @return the property generator
  */
 struct PropertyGenerator *
 GNUNET_ATS_solver_generate_property_start (unsigned int peer,
@@ -614,17 +617,19 @@
 
 
 /**
- * Generate between the source master and the partner and set preferences with 
a
+ * Generate between the source master and the partner and set property with a
  * value depending on the generator.
  *
- * @param src source
- * @param dest partner
- * @param type type of preferences to generate
- * @param base_rate traffic base rate to send data with
- * @param max_rate  traffic maximum rate to send data with
- * @param period duration of a period of traffic generation (~ 1/frequency)
- * @param duration how long to generate traffic
- * @return the traffic generator
+ * @param peer source
+ * @param address_id partner
+ * @param client_id the client
+ * @param type type of generator
+ * @param base_value base value
+ * @param value_rate maximum value
+ * @param period duration of a period of generation (~ 1/frequency)
+ * @param frequency how long to generate property
+ * @param kind ATS preference to generate
+ * @return the preference generator
  */
 struct PreferenceGenerator *
 GNUNET_ATS_solver_generate_preferences_start (unsigned int peer,
@@ -2253,6 +2258,7 @@
 /**
  * Information callback for the solver
  *
+ * @param cls the closure
  * @param op the solver operation
  * @param stat status of the solver operation
  * @param add additional solver information

Modified: gnunet/src/ats/plugin_ats_ril.c
===================================================================
--- gnunet/src/ats/plugin_ats_ril.c     2014-03-20 10:42:04 UTC (rev 32704)
+++ gnunet/src/ats/plugin_ats_ril.c     2014-03-20 10:42:14 UTC (rev 32705)
@@ -731,6 +731,7 @@
  * @param agent the agent handle
  * @param mod the kind of modification
  * @param feature the feature vector
+ * @param action the action to take
  */
 static void
 agent_modify_eligibility (struct RIL_Peer_Agent *agent,

Modified: gnunet/src/ats-tests/ats-testing-log.c
===================================================================
--- gnunet/src/ats-tests/ats-testing-log.c      2014-03-20 10:42:04 UTC (rev 
32704)
+++ gnunet/src/ats-tests/ats-testing-log.c      2014-03-20 10:42:14 UTC (rev 
32705)
@@ -878,6 +878,8 @@
  * @param testname the testname
  * @param masters the master peers used for benchmarking
  * @param num_masters the number of master peers
+ * @param num_slaves the number of slave peers
+ * @param verbose verbose logging
  * @return the logging handle or NULL on error
  */
 struct LoggingHandle *

Modified: gnunet/src/ats-tests/ats-testing-preferences.c
===================================================================
--- gnunet/src/ats-tests/ats-testing-preferences.c      2014-03-20 10:42:04 UTC 
(rev 32704)
+++ gnunet/src/ats-tests/ats-testing-preferences.c      2014-03-20 10:42:14 UTC 
(rev 32705)
@@ -132,11 +132,12 @@
  * @param src source
  * @param dest partner
  * @param type type of preferences to generate
- * @param base_rate traffic base rate to send data with
- * @param max_rate  traffic maximum rate to send data with
- * @param period duration of a period of traffic generation (~ 1/frequency)
- * @param duration how long to generate traffic
- * @return the traffic generator
+ * @param base_value traffic base rate to send data with
+ * @param value_rate  traffic maximum rate to send data with
+ * @param period duration of a period of preferences generation (~ 1/frequency)
+ * @param frequency how long to generate preferences
+ * @param kind ATS preference to generate
+ * @return the preference generator
  */
 struct PreferenceGenerator *
 GNUNET_ATS_TEST_generate_preferences_start (struct BenchmarkPeer *src,

Modified: gnunet/src/ats-tests/ats-testing.c
===================================================================
--- gnunet/src/ats-tests/ats-testing.c  2014-03-20 10:42:04 UTC (rev 32704)
+++ gnunet/src/ats-tests/ats-testing.c  2014-03-20 10:42:14 UTC (rev 32705)
@@ -865,8 +865,8 @@
  * @param test_core connect to CORE service (GNUNET_YES) or transport 
(GNUNET_NO)
  * @param done_cb function to call when topology is setup
  * @param done_cb_cls cls for callback
- * @param recv_cb callback to call when data are received
- * @param perf_cb callback to call when performance info are received
+ * @param transport_recv_cb callback to call when data are received
+ * @param log_request_cb callback to call when logging is required
  */
 void
 GNUNET_ATS_TEST_create_topology (char *name, char *cfg_file,

Modified: gnunet/src/ats-tests/ats-testing.h
===================================================================
--- gnunet/src/ats-tests/ats-testing.h  2014-03-20 10:42:04 UTC (rev 32704)
+++ gnunet/src/ats-tests/ats-testing.h  2014-03-20 10:42:14 UTC (rev 32705)
@@ -609,6 +609,20 @@
 void
 GNUNET_ATS_TEST_generate_traffic_stop_all ();
 
+/**
+ * Generate between the source master and the partner and set preferences with 
a
+ * value depending on the generator.
+ *
+ * @param src source
+ * @param dest partner
+ * @param type type of preferences to generate
+ * @param base_value traffic base rate to send data with
+ * @param value_rate  traffic maximum rate to send data with
+ * @param period duration of a period of preferences generation (~ 1/frequency)
+ * @param frequency how long to generate preferences
+ * @param kind ATS preference to generate
+ * @return the traffic generator
+ */
 struct PreferenceGenerator *
 GNUNET_ATS_TEST_generate_preferences_start (struct BenchmarkPeer *src,
     struct BenchmarkPartner *dest,
@@ -635,7 +649,9 @@
  * @param log_frequency the logging frequency
  * @param testname the testname
  * @param masters the master peers used for benchmarking
- * @param num_master the number of master peers
+ * @param num_masters the number of master peers
+ * @param num_slaves the number of slave peers
+ * @param verbose verbose logging
  * @return the logging handle or NULL on error
  */
 struct LoggingHandle *
@@ -699,8 +715,8 @@
  * @param test_core connect to CORE service (GNUNET_YES) or transport 
(GNUNET_NO)
  * @param done_cb function to call when topology is setup
  * @param done_cb_cls cls for callback
- * @param recv_cb callback to call when data are received
- * @param perf_cb callback to call when performance info are received
+ * @param transport_recv_cb callback to call when data are received
+ * @param log_request_cb callback to call when logging is required
  */
 void
 GNUNET_ATS_TEST_create_topology (char *name, char *cfg_file,

Modified: gnunet/src/transport/gnunet-service-transport_plugins.c
===================================================================
--- gnunet/src/transport/gnunet-service-transport_plugins.c     2014-03-20 
10:42:04 UTC (rev 32704)
+++ gnunet/src/transport/gnunet-service-transport_plugins.c     2014-03-20 
10:42:14 UTC (rev 32705)
@@ -86,6 +86,8 @@
  * plugin that caused the call.
  *
  * @param recv_cb function to call when data is received
+ * @param register_quota_cb function to call to register a quota callback
+ * @param unregister_quota_cb function to call to unregister a quota callback
  * @param address_cb function to call when our public addresses changed
  * @param session_start_cb function to call when a session was created
  * @param session_end_cb function to call when a session was terminated

Modified: gnunet/src/transport/gnunet-service-transport_plugins.h
===================================================================
--- gnunet/src/transport/gnunet-service-transport_plugins.h     2014-03-20 
10:42:04 UTC (rev 32704)
+++ gnunet/src/transport/gnunet-service-transport_plugins.h     2014-03-20 
10:42:14 UTC (rev 32705)
@@ -40,6 +40,8 @@
  * plugin that caused the call.
  *
  * @param recv_cb function to call when data is received
+ * @param register_quota_cb function to call to register a quota callback
+ * @param unregister_quota_cb function to call to unregister a quota callback
  * @param address_cb function to call when our public addresses changed
  * @param session_start_cb function to call when a session was created
  * @param session_end_cb function to call when a session was terminated