Skip to content

Commit ea90347

Browse files
committed
Update comments
1 parent 6e1b7a3 commit ea90347

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

include/message_buffer.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -767,6 +767,10 @@ typedef StreamBufferHandle_t MessageBufferHandle_t;
767767
* contained.
768768
*
769769
* A message buffer can only be reset if there are no tasks blocked on it.
770+
*
771+
* Use xMessageBufferReset() to reset a message buffer from a task.
772+
* Use xMessageBufferResetFromISR() to reset a maessage buffer from an
773+
* interrupt service routine (ISR).
770774
*
771775
* configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for
772776
* xMessageBufferReset() to be available.
@@ -791,11 +795,15 @@ typedef StreamBufferHandle_t MessageBufferHandle_t;
791795
* BaseType_t xMessageBufferResetFromISR( MessageBufferHandle_t xMessageBuffer );
792796
* @endcode
793797
*
794-
* An interrupt safe version of the API function that reset the stream buffer.
798+
* An interrupt safe version of the API function that resets the stream buffer.
795799
* Resets a message buffer to its initial empty state, discarding any message it
796800
* contained.
797801
*
798802
* A message buffer can only be reset if there are no tasks blocked on it.
803+
*
804+
* Use xMessageBufferReset() to reset a message buffer from a task.
805+
* Use xMessageBufferResetFromISR() to reset a maessage buffer from an
806+
* interrupt service routine (ISR).
799807
*
800808
* configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for
801809
* xMessageBufferResetFromISR() to be available.

include/stream_buffer.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -766,6 +766,10 @@ BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED
766766
* the stream buffer is discarded. A stream buffer can only be reset if there
767767
* are no tasks blocked waiting to either send to or receive from the stream
768768
* buffer.
769+
*
770+
* Use xStreamBufferReset() to reset a stream buffer from a task.
771+
* Use xStreamBufferResetFromISR() to reset a stream buffer from an
772+
* interrupt service routine (ISR).
769773
*
770774
* configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for
771775
* xStreamBufferReset() to be available.
@@ -788,12 +792,16 @@ BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_F
788792
* BaseType_t xStreamBufferResetFromISR( StreamBufferHandle_t xStreamBuffer );
789793
* @endcode
790794
*
791-
* An interrupt safe version of the API function that reset the stream buffer.
795+
* An interrupt safe version of the API function that resets the stream buffer.
792796
*
793797
* Resets a stream buffer to its initial, empty, state. Any data that was in
794798
* the stream buffer is discarded. A stream buffer can only be reset if there
795799
* are no tasks blocked waiting to either send to or receive from the stream
796800
* buffer.
801+
*
802+
* Use xStreamBufferReset() to reset a stream buffer from a task.
803+
* Use xStreamBufferResetFromISR() to reset a stream buffer from an
804+
* interrupt service routine (ISR).
797805
*
798806
* configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for
799807
* xStreamBufferResetFromISR() to be available.

0 commit comments

Comments
 (0)