Index: firmware/App/Services/CommBuffers.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Services/CommBuffers.c (.../CommBuffers.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Services/CommBuffers.c (.../CommBuffers.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -49,9 +49,8 @@ /*********************************************************************//** * @brief * The initCommBuffers function initializes the CommBuffers module. - * @details - * Inputs : none - * Outputs : CommBuffers module initialized. + * @details Inputs: none + * @details Outputs: CommBuffers module initialized. * @return none *************************************************************************/ void initCommBuffers( void ) @@ -70,9 +69,8 @@ * 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 - * Outputs : given buffer is cleared. + * @details Inputs: none + * @details Outputs: given buffer is cleared. * @param buffer the buffer to clear * @return none *************************************************************************/ @@ -104,9 +102,8 @@ * 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[] - * Outputs : commBuffers[], commBufferByteCount[] + * @details Inputs: commBufferByteCount[], activeDoubleBuffer[] + * @details Outputs: commBuffers[], commBufferByteCount[] * @param buffer which comm buffer to add data to * @param data pointer to byte array containing data to add * @param len length of data (in bytes) @@ -202,9 +199,8 @@ * rest of the requested data. * Only one function in one thread should be calling this function for a given * buffer. - * @details - * Inputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[] - * Outputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[], + * @details Inputs: commBuffers[], commBufferByteCount[], activeDoubleBuffer[] + * @details 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 @@ -262,9 +258,8 @@ * 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[] - * Outputs : given array populated with requested number of bytes from the buffer. + * @details Inputs: commBuffers[], commBufferByteCount[], activeDoubleBuffer[] + * @details Outputs: given array populated with requested number of bytes from the buffer. * @param buffer which comm buffer to retrieve data from * @param data pointer to byte array to stuff data into * @param len number of bytes to retrieve into given data array. @@ -317,9 +312,8 @@ * 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[] - * Outputs : none + * @details Inputs: activeDoubleBuffer[], commBufferByteCount[] + * @details Outputs: none * @param buffer which comm buffer to get byte count for * @return the number of bytes in the given comm buffer. *************************************************************************/ @@ -349,9 +343,8 @@ * 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[] - * Outputs : activeDoubleBuffer[], commBufferByteCount[] + * @details Inputs: activeDoubleBuffer[] + * @details Outputs: activeDoubleBuffer[], commBufferByteCount[] * @param buffer which comm buffer to switch double buffers on * @return the new active buffer for the given buffer. *************************************************************************/ @@ -374,9 +367,8 @@ * 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[] - * Outputs : commBuffers[], activeDoubleBuffer[], commBufferByteCount[] + * @details Inputs: commBuffers[], activeDoubleBuffer[], commBufferByteCount[] + * @details Outputs: commBuffers[], activeDoubleBuffer[], commBufferByteCount[] * @param buffer which comm buffer get data from * @param data pointer to byte array to populate with data * @param len number of bytes to get from comm buffer