Index: firmware/App/Services/CommBuffers.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Services/CommBuffers.c (.../CommBuffers.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Services/CommBuffers.c (.../CommBuffers.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -62,8 +62,8 @@ /************************************************************************* * @brief - * The clearBuffer function clears (empties) a given buffer. \n - * Caller should ensure buffer won't be used while this function is clearing \n + * The clearBuffer function clears (empties) a given buffer. + * Caller should ensure buffer won't be used while this function is clearing * the buffer. * @details * Inputs : none @@ -94,10 +94,10 @@ /************************************************************************* * @brief - * The addToCommBuffer function adds data of specified length to a specified \n - * communication buffer. S/W fault if buffer too full to add data. \n - * This function will always add to the active double buffer. \n - * This function should only be called from the background, general, or \n + * The addToCommBuffer function adds data of specified length to a specified + * communication buffer. S/W fault if buffer too full to add data. + * This function will always add to the active double buffer. + * This function should only be called from the background, general, or * priority tasks (BG or IRQ) for thread safety. * @details * Inputs : commBufferByteCount[], activeDoubleBuffer[] @@ -191,16 +191,16 @@ /************************************************************************* * @brief - * The getFromCommBuffer function fills a given byte array with a given \n - * number of bytes from a given buffer and returns the number of bytes \n - * retrieved from the buffer. This function will draw from the inactive \n - * double buffer first and, if needed, switch double buffers to draw the \n + * The getFromCommBuffer function fills a given byte array with a given + * number of bytes from a given buffer and returns the number of bytes + * retrieved from the buffer. This function will draw from the inactive + * double buffer first and, if needed, switch double buffers to draw the * rest of the requested data. - * Only one function in one thread should be calling this function for a given \n + * Only one function in one thread should be calling this function for a given * buffer. * @details * Inputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[] - * Outputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[], \n + * Outputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[], * and the given data array is populated with data from the buffer. * @param buffer which comm buffer to retrieve data from * @param data pointer to byte array to stuff data into @@ -252,11 +252,11 @@ /************************************************************************* * @brief - * The peekFromCommBuffer function fills a given byte array with a given \n - * number of bytes from a given buffer. This function does NOT consume \n - * the bytes - it only peeks at them. A call to numberOfBytesInCommBuffer() \n - * should be made before calling this function to determine how many bytes \n - * are currently in the buffer. Do not call this function with a "len" \n + * The peekFromCommBuffer function fills a given byte array with a given + * number of bytes from a given buffer. This function does NOT consume + * the bytes - it only peeks at them. A call to numberOfBytesInCommBuffer() + * should be made before calling this function to determine how many bytes + * are currently in the buffer. Do not call this function with a "len" * longer than what is currently in the buffer. * @details * Inputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[] @@ -310,8 +310,8 @@ /************************************************************************* * @brief - * The numberOfBytesInCommBuffer function determines how many bytes \n - * are currently contained in a given comm buffer. Both double buffers \n + * The numberOfBytesInCommBuffer function determines how many bytes + * are currently contained in a given comm buffer. Both double buffers * are considered for this. * @details * Inputs : activeDoubleBuffer[], commBufferByteCount[] @@ -341,9 +341,9 @@ /************************************************************************* * @brief - * The switchDoubleBuffer function switches the active and inactive buffers \n - * for the given buffer. \n - * This function should only be called when the current inactive buffer has \n + * The switchDoubleBuffer function switches the active and inactive buffers + * for the given buffer. + * This function should only be called when the current inactive buffer has * been emptied. Any unconsumed data in inactive buffer will be lost. * @details * Inputs : activeDoubleBuffer[] @@ -367,8 +367,8 @@ /************************************************************************* * @brief - * The getDataFromInactiveBuffer function retrieves a given number of bytes \n - * from the inactive buffer of a given buffer. This function should only be \n + * The getDataFromInactiveBuffer function retrieves a given number of bytes + * from the inactive buffer of a given buffer. This function should only be * called by getFromCommBuffer(). Params will be pre-validated there. * @details * Inputs : commBuffers[], activeDoubleBuffer[], commBufferByteCount[]