File tree 2 files changed +18
-2
lines changed 2 files changed +18
-2
lines changed Original file line number Diff line number Diff line change @@ -767,6 +767,10 @@ typedef StreamBufferHandle_t MessageBufferHandle_t;
767
767
* contained.
768
768
*
769
769
* 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).
770
774
*
771
775
* configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for
772
776
* xMessageBufferReset() to be available.
@@ -791,11 +795,15 @@ typedef StreamBufferHandle_t MessageBufferHandle_t;
791
795
* BaseType_t xMessageBufferResetFromISR( MessageBufferHandle_t xMessageBuffer );
792
796
* @endcode
793
797
*
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.
795
799
* Resets a message buffer to its initial empty state, discarding any message it
796
800
* contained.
797
801
*
798
802
* 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).
799
807
*
800
808
* configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for
801
809
* xMessageBufferResetFromISR() to be available.
Original file line number Diff line number Diff line change @@ -766,6 +766,10 @@ BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED
766
766
* the stream buffer is discarded. A stream buffer can only be reset if there
767
767
* are no tasks blocked waiting to either send to or receive from the stream
768
768
* 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).
769
773
*
770
774
* configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for
771
775
* xStreamBufferReset() to be available.
@@ -788,12 +792,16 @@ BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_F
788
792
* BaseType_t xStreamBufferResetFromISR( StreamBufferHandle_t xStreamBuffer );
789
793
* @endcode
790
794
*
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.
792
796
*
793
797
* Resets a stream buffer to its initial, empty, state. Any data that was in
794
798
* the stream buffer is discarded. A stream buffer can only be reset if there
795
799
* are no tasks blocked waiting to either send to or receive from the stream
796
800
* 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).
797
805
*
798
806
* configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for
799
807
* xStreamBufferResetFromISR() to be available.
You can’t perform that action at this time.
0 commit comments