Index: Timers.c =================================================================== diff -u -r62f81f0f9649926feae18dc09da001690dbcd26e -rbe2f042ab3fbb84ed87ca44577e123464b7281ae --- Timers.c (.../Timers.c) (revision 62f81f0f9649926feae18dc09da001690dbcd26e) +++ Timers.c (.../Timers.c) (revision be2f042ab3fbb84ed87ca44577e123464b7281ae) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -16,55 +16,57 @@ #include "Timers.h" +/** + * @addtogroup Timers + * @{ + */ + // ********** private definitions ********** // ********** private data ********** -static U32 msTimerCount = 0; +static U32 msTimerCount = 0; ///< 1ms timer counter incremented by TaskTimer.c. -/************************************************************************* +/*********************************************************************//** * @brief * The initTimers function initializes the Timers module. * @details * Inputs : none * Outputs : Timers module initialized. - * @param none * @return none *************************************************************************/ void initTimers( void ) { msTimerCount = 0; } -/************************************************************************* +/*********************************************************************//** * @brief * The incMSTimerCount function increments the ms timer count. * @details * Inputs : none * Outputs : msTimerCount incremented - * @param none * @return none *************************************************************************/ void incMSTimerCount( void ) { msTimerCount++; } -/************************************************************************* +/*********************************************************************//** * @brief * The getMSTimerCount function returns the current ms timer count. * @details * Inputs : msTimerCount * Outputs : none - * @param none * @return msTimerCount *************************************************************************/ U32 getMSTimerCount( void ) { return msTimerCount; } -/************************************************************************* +/*********************************************************************//** * @brief * The didTimeout function determines whether a timeout has occurred between \n * a given start count and a given timeout period (in ms). @@ -102,7 +104,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The calcTimeSince function calculates the time (in ms) from a given start \n * time until now. @@ -130,7 +132,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The calcTimeBetween function calculates the time (in ms) from a given start \n * time until a given end time. @@ -158,3 +160,5 @@ return result; } +/**@}*/ + Index: Timers.h =================================================================== diff -u -r62f81f0f9649926feae18dc09da001690dbcd26e -rbe2f042ab3fbb84ed87ca44577e123464b7281ae --- Timers.h (.../Timers.h) (revision 62f81f0f9649926feae18dc09da001690dbcd26e) +++ Timers.h (.../Timers.h) (revision be2f042ab3fbb84ed87ca44577e123464b7281ae) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -10,7 +10,7 @@ * @date 25-Sep-2019 * @author S. Nash * - * @brief header file for Timers service . + * @brief header file for Timers service module. * **************************************************************************/ @@ -19,6 +19,15 @@ #include "Common.h" +/** + * @defgroup Timers Timers + * @brief Timers service module. Provides timer utility functions based on + * a 1ms timer counter incremented by TaskTimer.c. + * + * @addtogroup Timers + * @{ + */ + // ********** public function prototypes ********** void initTimers( void ); @@ -28,4 +37,6 @@ U32 calcTimeSince( U32 startMSCount ); U32 calcTimeBetween( U32 startMSCount, U32 endMSCount ); +/**@}*/ + #endif