X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Ftimer.hpp;h=7d0e466915b379c2d2ea72078e0d81eccc3af511;hb=f9d6b3b462fa3db5a70e8bd1e1625d35f9e0f21b;hp=0454a802410e30e6bac89a6ce8a6a6276296db0c;hpb=747d58ad84d230f6cf11ac818bab65019df83611;p=apps%2Flow-level-can-service.git diff --git a/src/timer.hpp b/src/timer.hpp index 0454a80..7d0e466 100644 --- a/src/timer.hpp +++ b/src/timer.hpp @@ -19,15 +19,24 @@ #include +/* + * @brief return epoch in milliseconds + * + * @return long long int epoch in milliseconds + */ typedef long long int (*TimeFunction)(); /** - * @brief: A frequency counting clock. + * @struct FrequencyClock + * @brief A frequency counting clock. * - * frequency - the clock frequency in Hz. - * last_time - the last time (in milliseconds since startup) that the clock + * @var FrequencyClock::frequency + * the clock frequency in Hz. + * @var FrequencyClock::last_time + * the last time (in milliseconds since startup) that the clock * ticked. - * time_function - a function returning current time + * @var FrequencyClock::time_function + * a function returning current time */ typedef struct { float frequency;