Index: firmware/App/Services/Timers.c =================================================================== diff -u -rabb9687e52d9db5df1abe7626ba04a6d431ba823 -rc74c1d99a011dd0fb7f98f183faecda675221fce --- firmware/App/Services/Timers.c (.../Timers.c) (revision abb9687e52d9db5df1abe7626ba04a6d431ba823) +++ firmware/App/Services/Timers.c (.../Timers.c) (revision c74c1d99a011dd0fb7f98f183faecda675221fce) @@ -1,12 +1,10 @@ -/* - * Timers.c - * - * Created on: Aug 1, 2024 - * Author: fw - */ #include "Timers.h" +/** + * @addtogroup Timers + * @{ + */ // ********** private definitions ********** @@ -16,9 +14,9 @@ /*********************************************************************//** * @brief - * The initTimers function initializes the Timers module. - * @details Inputs: msTimerCount - * @details Outputs: msTimerCount + * The initTimers function initializes the Timers unit. + * @details \b Inputs: none + * @details \b Outputs: msTimerCount * @return none *************************************************************************/ void initTimers( void ) @@ -29,8 +27,8 @@ /*********************************************************************//** * @brief * The incMSTimerCount function increments the ms timer count. - * @details Inputs: msTimerCount - * @details Outputs: msTimerCount + * @details \b Inputs: msTimerCount + * @details \b Outputs: msTimerCount * @return none *************************************************************************/ void incMSTimerCount( void ) @@ -41,9 +39,9 @@ /*********************************************************************//** * @brief * The getMSTimerCount function returns the current ms timer count. - * @details Inputs: msTimerCount - * @details Outputs: none - * @return msTimerCount as a U32 + * @details \b Inputs: msTimerCount + * @details \b Outputs: none + * @return The current 32-bit millisecond timer count. *************************************************************************/ U32 getMSTimerCount( void ) { @@ -54,8 +52,8 @@ * @brief * The didTimeout function determines whether a timeout has occurred between * a given start count and a given timeout period (in ms). - * @details Inputs: msTimerCount - * @details Outputs: none + * @details \b Inputs: msTimerCount + * @details \b Outputs: none * @param startMSCount the ms count at the start of the timeout period * @param timeoutPeriod the period for the timeout (in ms) * @return TRUE if a timeout has occurred, FALSE if not @@ -87,6 +85,4 @@ return result; } - - - +/**@}*/