aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMatthias Wachs <wachs@net.in.tum.de>2014-03-20 10:42:14 +0000
committerMatthias Wachs <wachs@net.in.tum.de>2014-03-20 10:42:14 +0000
commit5ef3be020477b2e154b54a03f164002f5ff640dc (patch)
tree09ec57bf69937bdb6df1c38c0708cce9d355b1a5 /src
parentcfa6b17768e1cc863eb710714a55e02444025b1d (diff)
downloadgnunet-5ef3be020477b2e154b54a03f164002f5ff640dc.tar.gz
gnunet-5ef3be020477b2e154b54a03f164002f5ff640dc.zip
doxygen fixes
Diffstat (limited to 'src')
-rw-r--r--src/ats-tests/ats-testing-log.c2
-rw-r--r--src/ats-tests/ats-testing-preferences.c11
-rw-r--r--src/ats-tests/ats-testing.c4
-rw-r--r--src/ats-tests/ats-testing.h22
-rw-r--r--src/ats/gnunet-ats-solver-eval.c42
-rwxr-xr-xsrc/ats/plugin_ats_ril.c1
-rw-r--r--src/transport/gnunet-service-transport_plugins.c2
-rw-r--r--src/transport/gnunet-service-transport_plugins.h2
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)
878 * @param testname the testname 878 * @param testname the testname
879 * @param masters the master peers used for benchmarking 879 * @param masters the master peers used for benchmarking
880 * @param num_masters the number of master peers 880 * @param num_masters the number of master peers
881 * @param num_slaves the number of slave peers
882 * @param verbose verbose logging
881 * @return the logging handle or NULL on error 883 * @return the logging handle or NULL on error
882 */ 884 */
883struct LoggingHandle * 885struct 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,
132 * @param src source 132 * @param src source
133 * @param dest partner 133 * @param dest partner
134 * @param type type of preferences to generate 134 * @param type type of preferences to generate
135 * @param base_rate traffic base rate to send data with 135 * @param base_value traffic base rate to send data with
136 * @param max_rate traffic maximum rate to send data with 136 * @param value_rate traffic maximum rate to send data with
137 * @param period duration of a period of traffic generation (~ 1/frequency) 137 * @param period duration of a period of preferences generation (~ 1/frequency)
138 * @param duration how long to generate traffic 138 * @param frequency how long to generate preferences
139 * @return the traffic generator 139 * @param kind ATS preference to generate
140 * @return the preference generator
140 */ 141 */
141struct PreferenceGenerator * 142struct PreferenceGenerator *
142GNUNET_ATS_TEST_generate_preferences_start (struct BenchmarkPeer *src, 143GNUNET_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)
865 * @param test_core connect to CORE service (GNUNET_YES) or transport (GNUNET_NO) 865 * @param test_core connect to CORE service (GNUNET_YES) or transport (GNUNET_NO)
866 * @param done_cb function to call when topology is setup 866 * @param done_cb function to call when topology is setup
867 * @param done_cb_cls cls for callback 867 * @param done_cb_cls cls for callback
868 * @param recv_cb callback to call when data are received 868 * @param transport_recv_cb callback to call when data are received
869 * @param perf_cb callback to call when performance info are received 869 * @param log_request_cb callback to call when logging is required
870 */ 870 */
871void 871void
872GNUNET_ATS_TEST_create_topology (char *name, char *cfg_file, 872GNUNET_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);
609void 609void
610GNUNET_ATS_TEST_generate_traffic_stop_all (); 610GNUNET_ATS_TEST_generate_traffic_stop_all ();
611 611
612/**
613 * Generate between the source master and the partner and set preferences with a
614 * value depending on the generator.
615 *
616 * @param src source
617 * @param dest partner
618 * @param type type of preferences to generate
619 * @param base_value traffic base rate to send data with
620 * @param value_rate traffic maximum rate to send data with
621 * @param period duration of a period of preferences generation (~ 1/frequency)
622 * @param frequency how long to generate preferences
623 * @param kind ATS preference to generate
624 * @return the traffic generator
625 */
612struct PreferenceGenerator * 626struct PreferenceGenerator *
613GNUNET_ATS_TEST_generate_preferences_start (struct BenchmarkPeer *src, 627GNUNET_ATS_TEST_generate_preferences_start (struct BenchmarkPeer *src,
614 struct BenchmarkPartner *dest, 628 struct BenchmarkPartner *dest,
@@ -635,7 +649,9 @@ GNUNET_ATS_TEST_generate_preferences_stop_all ();
635 * @param log_frequency the logging frequency 649 * @param log_frequency the logging frequency
636 * @param testname the testname 650 * @param testname the testname
637 * @param masters the master peers used for benchmarking 651 * @param masters the master peers used for benchmarking
638 * @param num_master the number of master peers 652 * @param num_masters the number of master peers
653 * @param num_slaves the number of slave peers
654 * @param verbose verbose logging
639 * @return the logging handle or NULL on error 655 * @return the logging handle or NULL on error
640 */ 656 */
641struct LoggingHandle * 657struct LoggingHandle *
@@ -699,8 +715,8 @@ GNUNET_ATS_TEST_get_partner (int src, int dest);
699 * @param test_core connect to CORE service (GNUNET_YES) or transport (GNUNET_NO) 715 * @param test_core connect to CORE service (GNUNET_YES) or transport (GNUNET_NO)
700 * @param done_cb function to call when topology is setup 716 * @param done_cb function to call when topology is setup
701 * @param done_cb_cls cls for callback 717 * @param done_cb_cls cls for callback
702 * @param recv_cb callback to call when data are received 718 * @param transport_recv_cb callback to call when data are received
703 * @param perf_cb callback to call when performance info are received 719 * @param log_request_cb callback to call when logging is required
704 */ 720 */
705void 721void
706GNUNET_ATS_TEST_create_topology (char *name, char *cfg_file, 722GNUNET_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)
374 374
375 375
376/** 376/**
377 * Generate between the source master and the partner and set preferences with a 377 * Generate between the source master and the partner and set property with a
378 * value depending on the generator. 378 * value depending on the generator.
379 * 379 *
380 * @param src source 380 * @param peer source
381 * @param dest partner 381 * @param address_id partner
382 * @param type type of preferences to generate 382 * @param test_peer the peer
383 * @param base_rate traffic base rate to send data with 383 * @param test_address the address
384 * @param max_rate traffic maximum rate to send data with 384 * @param type type of generator
385 * @param period duration of a period of traffic generation (~ 1/frequency) 385 * @param base_value base value
386 * @param duration how long to generate traffic 386 * @param value_rate maximum value
387 * @return the traffic generator 387 * @param period duration of a period of generation (~ 1/frequency)
388 * @param frequency how long to generate property
389 * @param ats_property ATS property to generate
390 * @return the property generator
388 */ 391 */
389struct PropertyGenerator * 392struct PropertyGenerator *
390GNUNET_ATS_solver_generate_property_start (unsigned int peer, 393GNUNET_ATS_solver_generate_property_start (unsigned int peer,
@@ -614,17 +617,19 @@ GNUNET_ATS_solver_generate_preferences_stop (struct PreferenceGenerator *pg)
614 617
615 618
616/** 619/**
617 * Generate between the source master and the partner and set preferences with a 620 * Generate between the source master and the partner and set property with a
618 * value depending on the generator. 621 * value depending on the generator.
619 * 622 *
620 * @param src source 623 * @param peer source
621 * @param dest partner 624 * @param address_id partner
622 * @param type type of preferences to generate 625 * @param client_id the client
623 * @param base_rate traffic base rate to send data with 626 * @param type type of generator
624 * @param max_rate traffic maximum rate to send data with 627 * @param base_value base value
625 * @param period duration of a period of traffic generation (~ 1/frequency) 628 * @param value_rate maximum value
626 * @param duration how long to generate traffic 629 * @param period duration of a period of generation (~ 1/frequency)
627 * @return the traffic generator 630 * @param frequency how long to generate property
631 * @param kind ATS preference to generate
632 * @return the preference generator
628 */ 633 */
629struct PreferenceGenerator * 634struct PreferenceGenerator *
630GNUNET_ATS_solver_generate_preferences_start (unsigned int peer, 635GNUNET_ATS_solver_generate_preferences_start (unsigned int peer,
@@ -2253,6 +2258,7 @@ GNUNET_ATS_solvers_load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg,
2253/** 2258/**
2254 * Information callback for the solver 2259 * Information callback for the solver
2255 * 2260 *
2261 * @param cls the closure
2256 * @param op the solver operation 2262 * @param op the solver operation
2257 * @param stat status of the solver operation 2263 * @param stat status of the solver operation
2258 * @param add additional solver information 2264 * @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
731 * @param agent the agent handle 731 * @param agent the agent handle
732 * @param mod the kind of modification 732 * @param mod the kind of modification
733 * @param feature the feature vector 733 * @param feature the feature vector
734 * @param action the action to take
734 */ 735 */
735static void 736static void
736agent_modify_eligibility (struct RIL_Peer_Agent *agent, 737agent_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;
86 * plugin that caused the call. 86 * plugin that caused the call.
87 * 87 *
88 * @param recv_cb function to call when data is received 88 * @param recv_cb function to call when data is received
89 * @param register_quota_cb function to call to register a quota callback
90 * @param unregister_quota_cb function to call to unregister a quota callback
89 * @param address_cb function to call when our public addresses changed 91 * @param address_cb function to call when our public addresses changed
90 * @param session_start_cb function to call when a session was created 92 * @param session_start_cb function to call when a session was created
91 * @param session_end_cb function to call when a session was terminated 93 * @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 @@
40 * plugin that caused the call. 40 * plugin that caused the call.
41 * 41 *
42 * @param recv_cb function to call when data is received 42 * @param recv_cb function to call when data is received
43 * @param register_quota_cb function to call to register a quota callback
44 * @param unregister_quota_cb function to call to unregister a quota callback
43 * @param address_cb function to call when our public addresses changed 45 * @param address_cb function to call when our public addresses changed
44 * @param session_start_cb function to call when a session was created 46 * @param session_start_cb function to call when a session was created
45 * @param session_end_cb function to call when a session was terminated 47 * @param session_end_cb function to call when a session was terminated