diff --git a/include/message_buffer.h b/include/message_buffer.h index 785c26d8e..ef94b6a3e 100644 --- a/include/message_buffer.h +++ b/include/message_buffer.h @@ -767,6 +767,10 @@ typedef StreamBufferHandle_t MessageBufferHandle_t; * contained. * * A message buffer can only be reset if there are no tasks blocked on it. + * + * Use xMessageBufferReset() to reset a message buffer from a task. + * Use xMessageBufferResetFromISR() to reset a maessage buffer from an + * interrupt service routine (ISR). * * configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for * xMessageBufferReset() to be available. @@ -791,11 +795,15 @@ typedef StreamBufferHandle_t MessageBufferHandle_t; * BaseType_t xMessageBufferResetFromISR( MessageBufferHandle_t xMessageBuffer ); * @endcode * - * An interrupt safe version of the API function that reset the stream buffer. + * An interrupt safe version of the API function that resets the stream buffer. * Resets a message buffer to its initial empty state, discarding any message it * contained. * * A message buffer can only be reset if there are no tasks blocked on it. + * + * Use xMessageBufferReset() to reset a message buffer from a task. + * Use xMessageBufferResetFromISR() to reset a maessage buffer from an + * interrupt service routine (ISR). * * configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for * xMessageBufferResetFromISR() to be available. diff --git a/include/stream_buffer.h b/include/stream_buffer.h index ef77c33ae..9847b31f8 100644 --- a/include/stream_buffer.h +++ b/include/stream_buffer.h @@ -766,6 +766,10 @@ BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED * the stream buffer is discarded. A stream buffer can only be reset if there * are no tasks blocked waiting to either send to or receive from the stream * buffer. + * + * Use xStreamBufferReset() to reset a stream buffer from a task. + * Use xStreamBufferResetFromISR() to reset a stream buffer from an + * interrupt service routine (ISR). * * configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for * xStreamBufferReset() to be available. @@ -788,12 +792,16 @@ BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_F * BaseType_t xStreamBufferResetFromISR( StreamBufferHandle_t xStreamBuffer ); * @endcode * - * An interrupt safe version of the API function that reset the stream buffer. + * An interrupt safe version of the API function that resets the stream buffer. * * Resets a stream buffer to its initial, empty, state. Any data that was in * the stream buffer is discarded. A stream buffer can only be reset if there * are no tasks blocked waiting to either send to or receive from the stream * buffer. + * + * Use xStreamBufferReset() to reset a stream buffer from a task. + * Use xStreamBufferResetFromISR() to reset a stream buffer from an + * interrupt service routine (ISR). * * configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for * xStreamBufferResetFromISR() to be available.