Index: firmware/App/Services/MsgQueues.c =================================================================== diff -u -rf308cc4c35eab630ebbbde405cfe47d049afeafb -r7d4711edd7b40cd3e29f43e766f79a8a09586fe9 --- firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision f308cc4c35eab630ebbbde405cfe47d049afeafb) +++ firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision 7d4711edd7b40cd3e29f43e766f79a8a09586fe9) @@ -1,21 +1,26 @@ /************************************************************************** * -* Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. +* Copyright (c) 2019-2024 Diality Inc. - All Rights Reserved. * * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * -* @file MsgQueues.c +* @file MsgQueues.c * -* @author (last) Quang Nguyen -* @date (last) 22-Jul-2020 +* @author (last) Quang Nguyen +* @date (last) 24-Sep-2020 * -* @author (original) Dara Navaei -* @date (original) 05-Nov-2019 +* @author (original) Dara Navaei +* @date (original) 05-Nov-2019 * ***************************************************************************/ #include "MsgQueues.h" + +/** + * @addtogroup MsgQueues + * @{ + */ // ********** private definitions ********** @@ -30,12 +35,11 @@ // ********** private function prototypes ********** -/************************************************************************* - * @brief initMsgQueues +/*********************************************************************//** + * @brief * The initMsgQueues function initializes the MsgQueues module. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: MsgQueues module initialized * @return none *************************************************************************/ void initMsgQueues( void ) @@ -54,14 +58,13 @@ } } } - -/************************************************************************* - * @brief addToMsgQueue - * The addToMsgQueue function adds a message to a given message queue. \n - * This function should only be called from the General Task. - * @details - * Inputs : none - * Outputs : message added to queue + +/*********************************************************************//** + * @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 * @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 @@ -95,17 +98,15 @@ 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. - * @details - * Inputs : queue - * Outputs : message retrieved from the queue + +/*********************************************************************//** + * @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 * @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,13 +138,12 @@ return result; } - -/************************************************************************* - * @brief isMsgQueueEmpty + +/*********************************************************************//** + * @brief * The isMsgQueueEmpty function determines whether a given message queue is empty. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: msgQueueCounts[] + * @details Outputs: none * @param queue the message queue to check * @return TRUE if a given message queue is empty, FALSE if not *************************************************************************/ @@ -166,13 +166,12 @@ return result; } - -/************************************************************************* - * @brief isMsgQueueFull + +/*********************************************************************//** + * @brief * The isMsgQueueFull function determines whether a given message queue is full. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: msgQueueCounts[] + * @details Outputs: none * @param queue the message queue to check * @return TRUE if the given message queue is full, FALSE if not *************************************************************************/ @@ -195,13 +194,12 @@ return result; } - -/************************************************************************* - * @brief blankMessage + +/*********************************************************************//** + * @brief * The blankMessage function blanks a given message. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: Zeroed out the message * @param message Pointer to the message to blank * @return none *************************************************************************/ @@ -217,14 +215,13 @@ *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 + * @details Inputs: none + * @details 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 +239,5 @@ // set msg ID out of bounds in case blank message goes somewhere message->msg.hdr.msgID = 0xFFFF; } + +/**@}*/