planix.org/actube
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added some comments.

Browse Source 
FossilOrigin-Name: 0be0963ac9db29acebbd006a3d2a0ce283cbe41e79244f528f1280c3ed07b891
This commit is contained in:
7u83@mail.ru
2015-10-17 17:28:07 +00:00
parent 04e76bc280
commit 70a9e8efae
1 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
src/capwap/timer.h
View File

@ -24,7 +24,7 @@
#include <sys/time.h>
/**
* @defgroup TimerFunctions Timer Functions
* @defgroup TimerFunctions Timer & Clock Functions
* @{
*/
@ -58,24 +58,33 @@ typedef time_t cw_timer_t;
/**
* Define a clock variable to measure runtime (not CPU runtime, but
* real time). This variable can be used with #cw_clock_start
* real time). The created variable can be used with #cw_clock_start
* and #cw_clock_lap.
*
* @param c name of the variable
*
* Example:
* @code
* CW_CLOCK_DEFINE(clk);
* cw_clock_start(clk);
* // do something ...
* int t = cw_clock_lap(clk);
* printf("Caclulation took %d seconds\n",t);
* @endcode
*
*/
#define CLOCK_DEFINE(c)\
#define CW_CLOCK_DEFINE(c)\
struct timeval c;
/**
* Start the clock (stop watch), start measuring time
* @param c a pounter to a variable defined with #DEFINE_CLOCK
* @param c a pouiter to a variable defined with #CW_CLOCK_DEFINE
*/
#define cw_clock_start(c)\
gettimeofday(c,NULL);
/**
* Get lap time. (stop watch)
* @param tv pointer to a clock variable defined with #CLOCK_DEFINE
* @param tv pointer to a clock variable defined with #CW_CLOCK_DEFINE
* @return lap time in seconds.
*/
static inline double cw_clock_lap(struct timeval *tv)