fixes for doxygen
authorMatthias Wachs <wachs@net.in.tum.de>
Mon, 27 Jan 2014 09:42:40 +0000 (09:42 +0000)
committerMatthias Wachs <wachs@net.in.tum.de>
Mon, 27 Jan 2014 09:42:40 +0000 (09:42 +0000)
src/ats-tests/ats-testing-log.c
src/ats-tests/ats-testing.h
src/ats-tests/gnunet-ats-sim.c

index 2e3a89e5abfeaf96571d13933d899d6ff66390a9..ffd55c88e87e5c363d95cb9f22b44de06f8d65a2 100644 (file)
@@ -656,7 +656,11 @@ collect_log_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
       &collect_log_task, l);
 }
 
-
+/**
+ * Stop logging
+ *
+ * @param l the logging handle
+ */
 void
 GNUNET_ATS_TEST_logging_stop (struct LoggingHandle *l)
 {
@@ -691,6 +695,16 @@ GNUNET_ATS_TEST_logging_stop (struct LoggingHandle *l)
   GNUNET_free (l);
 }
 
+
+/**
+ * Start logging
+ *
+ * @param log_frequency the logging frequency
+ * @param testname the testname
+ * @param masters the master peers used for benchmarking
+ * @oaram num_master the number of master peers
+ * @return the logging handle or NULL on error
+ */
 struct LoggingHandle *
 GNUNET_ATS_TEST_logging_start (struct GNUNET_TIME_Relative log_frequency,
     char * testname, struct BenchmarkPeer *masters, int num_masters)
index a2937d51d7374070a626815f1b070cfb2d6f78f2..705ea66051cb460d5ac5b84933cd97df387edbb5 100644 (file)
@@ -472,6 +472,12 @@ GNUNET_ATS_TEST_generate_traffic_stop_all ();
 
 /**
  * Start logging
+ *
+ * @param log_frequency the logging frequency
+ * @param testname the testname
+ * @param masters the master peers used for benchmarking
+ * @oaram num_master the number of master peers
+ * @return the logging handle or NULL on error
  */
 struct LoggingHandle *
 GNUNET_ATS_TEST_logging_start (struct GNUNET_TIME_Relative log_frequency,
@@ -479,9 +485,11 @@ GNUNET_ATS_TEST_logging_start (struct GNUNET_TIME_Relative log_frequency,
 
 /**
  * Stop logging
+ *
+ * @param l the logging handle
  */
 void
-GNUNET_ATS_TEST_logging_stop (struct LoggingHandle *);
+GNUNET_ATS_TEST_logging_stop (struct LoggingHandle *l);
 
 /**
  * Log all data now
index a15afa63942263e68c3915ba4f86328175fe5696..6f95d9ce1b8a82faf969ead4f46ca27aaf943408 100644 (file)
@@ -18,7 +18,7 @@
  Boston, MA 02111-1307, USA.
  */
 /**
- * @file ats-test/gnunet-ats-sim.c
+ * @file ats-tests/gnunet-ats-sim.c
  * @brief ats traffic simulator: this tool uses the ats-test library to setup a
  * topology and generate traffic between these peers. The traffic description
  * is loaded from a experiment description file