doxygen: use correct comment syntax

[openocd.git] / src / helper / time_support.h

diff --git a/src/helper/time_support.h b/src/helper/time_support.h
index 311c88d32e8fd655b3dae9046d2d0fba7b7ab1de..4c46127dfd23f98a20e456089344af652071babd 100644 (file)
--- a/src/helper/time_support.h
+++ b/src/helper/time_support.h
@@ -2,6 +2,12 @@
  *   Copyright (C) 2006 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
+ *   Copyright (C) 2008 by Spencer Oliver                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
@@ -17,6 +23,7 @@
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+
 #ifndef TIME_SUPPORT_H
 #define TIME_SUPPORT_H
 
@@ -31,19 +38,25 @@
 # endif
 #endif
 
-extern int timeval_subtract(struct timeval *result, struct timeval *x, struct timeval *y);
-extern int timeval_add(struct timeval *result, struct timeval *x, struct timeval *y);
-extern int timeval_add_time(struct timeval *result, int sec, int usec);
-/* gettimeofday() timeval in 64 bit ms */
-extern long long timeval_ms();
+int timeval_subtract(struct timeval *result, struct timeval *x, struct timeval *y);
+int timeval_add_time(struct timeval *result, long sec, long usec);
 
-typedef struct duration_s
-{
+/** @returns gettimeofday() timeval as 64-bit in ms */
+int64_t timeval_ms(void);
+
+struct duration {
        struct timeval start;
-       struct timeval duration;
-} duration_t;
+       struct timeval elapsed;
+};
+
+/** Update the duration->start field to start the @a duration measurement. */
+int duration_start(struct duration *duration);
+/** Update the duration->elapsed field to finish the @a duration measurment. */
+int duration_measure(struct duration *duration);
 
-extern int duration_start_measure(duration_t *duration);
-extern int duration_stop_measure(duration_t *duration, char **text);
+/** @returns Elapsed time in seconds. */
+float duration_elapsed(struct duration *duration);
+/** @returns KB/sec for the elapsed @a duration and @a count bytes. */
+float duration_kbps(struct duration *duration, size_t count);
 
-#endif /* TIME_SUPPORT_H */
+#endif /* TIME_SUPPORT_H */