Index: Timers.c =================================================================== diff -u -r6d80d69a210f45c733e5307859351f2cd820a8e7 -r5fb988facecb08dceb2bba1c462d3097b53617f0 --- Timers.c (.../Timers.c) (revision 6d80d69a210f45c733e5307859351f2cd820a8e7) +++ Timers.c (.../Timers.c) (revision 5fb988facecb08dceb2bba1c462d3097b53617f0) @@ -30,9 +30,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 ) @@ -43,8 +43,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 ) @@ -55,9 +55,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 ) { @@ -68,8 +68,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 @@ -104,11 +104,11 @@ /*********************************************************************//** * @brief * The calcTimeSince function calculates the time (in ms) from a given start - * time until now. - * @details Inputs: msTimerCount - * @details Outputs: none + * time until right now. + * @details \b Inputs: msTimerCount + * @details \b Outputs: none * @param startMSCount the ms count at the start of the period - * @return ms since given start time + * @return The number of milliseconds since the given start time. *************************************************************************/ U32 calcTimeSince( U32 startMSCount ) { @@ -132,11 +132,11 @@ * @brief * The calcTimeBetween function calculates the time (in ms) from a given start * time until a given end time. - * @details Inputs: none - * @details Outputs: none + * @details \b Inputs: none + * @details \b Outputs: none * @param startMSCount the ms count at the start of the period * @param endMSCount the ms count at the end of the period - * @return ms between two given times + * @return The number of milliseconds between the given start and end times *************************************************************************/ U32 calcTimeBetween( U32 startMSCount, U32 endMSCount ) {