From 5ef3be020477b2e154b54a03f164002f5ff640dc Mon Sep 17 00:00:00 2001 From: Matthias Wachs Date: Thu, 20 Mar 2014 10:42:14 +0000 Subject: doxygen fixes --- src/ats-tests/ats-testing-log.c | 2 ++ src/ats-tests/ats-testing-preferences.c | 11 ++++--- src/ats-tests/ats-testing.c | 4 +-- src/ats-tests/ats-testing.h | 22 +++++++++++-- src/ats/gnunet-ats-solver-eval.c | 42 ++++++++++++++---------- src/ats/plugin_ats_ril.c | 1 + src/transport/gnunet-service-transport_plugins.c | 2 ++ src/transport/gnunet-service-transport_plugins.h | 2 ++ 8 files changed, 58 insertions(+), 28 deletions(-) diff --git a/src/ats-tests/ats-testing-log.c b/src/ats-tests/ats-testing-log.c index e18b744c9..c662844d7 100644 --- a/src/ats-tests/ats-testing-log.c +++ b/src/ats-tests/ats-testing-log.c @@ -878,6 +878,8 @@ GNUNET_ATS_TEST_logging_clean_up (struct LoggingHandle *l) * @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 * diff --git a/src/ats-tests/ats-testing-preferences.c b/src/ats-tests/ats-testing-preferences.c index 71ae342b8..1b11bd924 100644 --- a/src/ats-tests/ats-testing-preferences.c +++ b/src/ats-tests/ats-testing-preferences.c @@ -132,11 +132,12 @@ set_pref_task (void *cls, * @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, diff --git a/src/ats-tests/ats-testing.c b/src/ats-tests/ats-testing.c index a3051fdc6..49c3c841b 100644 --- a/src/ats-tests/ats-testing.c +++ b/src/ats-tests/ats-testing.c @@ -865,8 +865,8 @@ GNUNET_ATS_TEST_get_partner (int src, int dest) * @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, diff --git a/src/ats-tests/ats-testing.h b/src/ats-tests/ats-testing.h index ef3819ce4..c74a460f0 100644 --- a/src/ats-tests/ats-testing.h +++ b/src/ats-tests/ats-testing.h @@ -609,6 +609,20 @@ GNUNET_ATS_TEST_generate_traffic_stop (struct TrafficGenerator *tg); 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 @@ GNUNET_ATS_TEST_generate_preferences_stop_all (); * @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 @@ GNUNET_ATS_TEST_get_partner (int src, int dest); * @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, diff --git a/src/ats/gnunet-ats-solver-eval.c b/src/ats/gnunet-ats-solver-eval.c index 7eb1638df..131781768 100644 --- a/src/ats/gnunet-ats-solver-eval.c +++ b/src/ats/gnunet-ats-solver-eval.c @@ -374,17 +374,20 @@ GNUNET_ATS_solver_generate_property_stop (struct PropertyGenerator *pg) /** - * 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 @@ GNUNET_ATS_solver_generate_preferences_stop (struct PreferenceGenerator *pg) /** - * 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 @@ GNUNET_ATS_solvers_load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, /** * 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 diff --git a/src/ats/plugin_ats_ril.c b/src/ats/plugin_ats_ril.c index 0a64cfee9..2bf715eb9 100755 --- a/src/ats/plugin_ats_ril.c +++ b/src/ats/plugin_ats_ril.c @@ -731,6 +731,7 @@ agent_update (struct RIL_Peer_Agent *agent, double reward, double *s_next, int a * @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, diff --git a/src/transport/gnunet-service-transport_plugins.c b/src/transport/gnunet-service-transport_plugins.c index c5b15cf42..846461a4c 100644 --- a/src/transport/gnunet-service-transport_plugins.c +++ b/src/transport/gnunet-service-transport_plugins.c @@ -86,6 +86,8 @@ static struct TransportPlugin *plugins_tail; * 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 diff --git a/src/transport/gnunet-service-transport_plugins.h b/src/transport/gnunet-service-transport_plugins.h index 561b79a9d..15d8463fb 100644 --- a/src/transport/gnunet-service-transport_plugins.h +++ b/src/transport/gnunet-service-transport_plugins.h @@ -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 -- cgit v1.2.3