Index: firmware/App/Services/MsgQueues.c =================================================================== diff -u -rdc0d9b087c609e71cacdb7f0395cccf29d749c00 -r482f4465ccdb813922de506bf780e29f4fb2f84b --- firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision dc0d9b087c609e71cacdb7f0395cccf29d749c00) +++ firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision 482f4465ccdb813922de506bf780e29f4fb2f84b) @@ -16,6 +16,11 @@ ***************************************************************************/ #include "MsgQueues.h" + +/** + * @addtogroup MsgQueues + * @{ + */ // ********** private definitions ********** @@ -30,12 +35,12 @@ // ********** private function prototypes ********** -/************************************************************************* - * @brief initMsgQueues +/*********************************************************************//** + * @brief * The initMsgQueues function initializes the MsgQueues module. * @details * Inputs : none - * Outputs : none + * Outputs : MsgQueues module initialized * @return none *************************************************************************/ void initMsgQueues( void ) @@ -54,11 +59,11 @@ } } } - -/************************************************************************* - * @brief addToMsgQueue - * The addToMsgQueue function adds a message to a given message queue. \n - * This function should only be called from the General Task. + +/*********************************************************************//** + * @brief + * The addToMsgQueue function adds a message to a given message queue. + * This function should only be called from the general task. * @details * Inputs : none * Outputs : message added to queue @@ -95,17 +100,16 @@ return result; } - -/************************************************************************* - * @brief getFromMsgQueue - * The getFromMsgQueue function retrieves the next message from a given \n - * message queue. This function should only be called from the General Task. + +/*********************************************************************//** + * @brief + * The getFromMsgQueue function retrieves the next message from a given + * message queue. This function should only be called from the general task. * @details * Inputs : queue * Outputs : message retrieved from the queue * @param queue the message queue to retrieve from - * @param msg a pointer to a message structure to populate with the retrieved \n - * message. + * @param msg a pointer to a message structure to populate with the retrieved message. * @return TRUE if a message was found to retrieve, FALSE if not *************************************************************************/ BOOL getFromMsgQueue( MSG_QUEUE_T queue, MESSAGE_WRAPPER_T *msg ) @@ -137,12 +141,12 @@ return result; } - -/************************************************************************* - * @brief isMsgQueueEmpty + +/*********************************************************************//** + * @brief * The isMsgQueueEmpty function determines whether a given message queue is empty. * @details - * Inputs : none + * Inputs : msgQueueCounts[] * Outputs : none * @param queue the message queue to check * @return TRUE if a given message queue is empty, FALSE if not @@ -166,12 +170,12 @@ return result; } - -/************************************************************************* - * @brief isMsgQueueFull + +/*********************************************************************//** + * @brief * The isMsgQueueFull function determines whether a given message queue is full. * @details - * Inputs : none + * Inputs : msgQueueCounts[] * Outputs : none * @param queue the message queue to check * @return TRUE if the given message queue is full, FALSE if not @@ -195,13 +199,13 @@ return result; } - -/************************************************************************* - * @brief blankMessage + +/*********************************************************************//** + * @brief * The blankMessage function blanks a given message. * @details * Inputs : none - * Outputs : none + * Outputs : Zeroed out the message * @param message Pointer to the message to blank * @return none *************************************************************************/ @@ -217,14 +221,14 @@ *msgContent++ = 0x0; } } - -/************************************************************************* - * @brief blankMessageInWrapper + +/*********************************************************************//** + * @brief * The blankMessageInWrapper function blanks a given message in a wrapper. * @details * Inputs : none - * Outputs : none - * @param message Pointer to the message in a wrapper to blank + * Outputs : Zeroed out the message in wrapper + * @param message pointer to the message in a wrapper to blank * @return none *************************************************************************/ void blankMessageInWrapper( MESSAGE_WRAPPER_T *message ) @@ -242,3 +246,5 @@ // set msg ID out of bounds in case blank message goes somewhere message->msg.hdr.msgID = 0xFFFF; } + +/**@}*/