Index: firmware/App/Services/MsgQueues.c =================================================================== diff -u -r52ded7b22d4b413aa8182f1343e4fbb78e8c3b0a -r090cfb22a7c0b4738299c3fb411ca77aaba8d968 --- firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision 52ded7b22d4b413aa8182f1343e4fbb78e8c3b0a) +++ firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision 090cfb22a7c0b4738299c3fb411ca77aaba8d968) @@ -38,8 +38,8 @@ /*********************************************************************//** * @brief * The initMsgQueues function initializes the MsgQueues module. - * @details Inputs: none - * @details Outputs: MsgQueues module initialized + * @details \b Inputs: none + * @details \b Outputs: MsgQueues module initialized * @return none *************************************************************************/ void initMsgQueues( void ) @@ -61,13 +61,15 @@ /*********************************************************************//** * @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 - * @details Outputs: message added to queue + * The addToMsgQueue function adds a message to a given message queue. * + * @details \b Inputs: none + * @details \b Outputs: message added to queue + * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when message queue is full + * or invalid queue passed * @param queue the message queue to add to * @param msg a pointer to a message structure to add to the queue - * @return TRUE if message added to queue, FALSE if could not + * @return TRUE if message added to queue, FALSE if could not + * @warning This function should only be called from the general task. *************************************************************************/ BOOL addToMsgQueue( MSG_QUEUE_T queue, MESSAGE_WRAPPER_T *msg ) { @@ -102,12 +104,15 @@ /*********************************************************************//** * @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 - * @details Outputs: message retrieved from the queue + * message queue. + * @details \b Inputs: queue + * @details \b Outputs: message retrieved from the queue + * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid queue used to + * retrieve the message. * @param queue the message queue to retrieve from * @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 + * @return TRUE if a message was found to retrieve, FALSE if not + * @warning This function should only be called from the general task. *************************************************************************/ BOOL getFromMsgQueue( MSG_QUEUE_T queue, MESSAGE_WRAPPER_T *msg ) { @@ -142,8 +147,10 @@ /*********************************************************************//** * @brief * The isMsgQueueEmpty function determines whether a given message queue is empty. - * @details Inputs: msgQueueCounts[] - * @details Outputs: none + * @details \b Inputs: msgQueueCounts[] + * @details \b Outputs: none + * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid message queue being + * passed. * @param queue the message queue to check * @return TRUE if a given message queue is empty, FALSE if not *************************************************************************/ @@ -170,8 +177,10 @@ /*********************************************************************//** * @brief * The isMsgQueueFull function determines whether a given message queue is full. - * @details Inputs: msgQueueCounts[] - * @details Outputs: none + * @details \b Inputs: msgQueueCounts[] + * @details \b Outputs: none + * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid message queue being + * passed. * @param queue the message queue to check * @return TRUE if the given message queue is full, FALSE if not *************************************************************************/ @@ -198,8 +207,8 @@ /*********************************************************************//** * @brief * The blankMessage function blanks a given message. - * @details Inputs: none - * @details Outputs: Zeroed out the message + * @details \b Inputs: none + * @details \b Outputs: Zeroed out the message * @param message Pointer to the message to blank * @return none *************************************************************************/ @@ -219,8 +228,8 @@ /*********************************************************************//** * @brief * The blankMessageInWrapper function blanks a given message in a wrapper. - * @details Inputs: none - * @details Outputs: Zeroed out the message in wrapper + * @details \b Inputs: none + * @details \b Outputs: Zeroed out the message in wrapper * @param message pointer to the message in a wrapper to blank * @return none *************************************************************************/