Skip to content

Commit 61b2cbb

Browse files
author
Amanda Butler
authored
Copy edit Queue.h
Copy edit file for active voice.
1 parent 0d772db commit 61b2cbb

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

rtos/Queue.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class Queue : private mbed::NonCopyable<Queue<T, queue_sz> > {
5454
public:
5555
/** Create and initialize a message Queue.
5656
*
57-
* @note This function cannot be called from ISR context.
57+
* @note You cannot call this function from ISR context.
5858
*/
5959
Queue() {
6060
memset(&_obj_mem, 0, sizeof(_obj_mem));
@@ -68,7 +68,7 @@ class Queue : private mbed::NonCopyable<Queue<T, queue_sz> > {
6868
}
6969
/** Queue destructor
7070
*
71-
* @note This function cannot be called from ISR context.
71+
* @note You cannot call this function from ISR context.
7272
*/
7373
~Queue() {
7474
osMessageQueueDelete(_id);
@@ -78,7 +78,7 @@ class Queue : private mbed::NonCopyable<Queue<T, queue_sz> > {
7878
*
7979
* @return True if the queue is empty, false if not
8080
*
81-
* @note This function may be called from ISR context.
81+
* @note You may call this function from ISR context.
8282
*/
8383
bool empty() const {
8484
return osMessageQueueGetCount(_id) == 0;
@@ -88,7 +88,7 @@ class Queue : private mbed::NonCopyable<Queue<T, queue_sz> > {
8888
*
8989
* @return True if the queue is full, false if not
9090
*
91-
* @note This function may be called from ISR context.
91+
* @note You may call this function from ISR context.
9292
*/
9393
bool full() const {
9494
return osMessageQueueGetSpace(_id) == 0;
@@ -104,7 +104,7 @@ class Queue : private mbed::NonCopyable<Queue<T, queue_sz> > {
104104
@a osErrorResource not enough space in the queue.
105105
@a osErrorParameter internal error or non-zero timeout specified in an ISR.
106106
107-
@note This function may be called from ISR context if the millisec parameter is set to 0.
107+
@note You may call this function from ISR context if the millisec parameter is set to 0.
108108
*/
109109
osStatus put(T* data, uint32_t millisec=0, uint8_t prio=0) {
110110
return osMessageQueuePut(_id, &data, prio, millisec);
@@ -119,7 +119,7 @@ class Queue : private mbed::NonCopyable<Queue<T, queue_sz> > {
119119
@a osEventTimeout no message has arrived during the given timeout period.
120120
@a osErrorParameter a parameter is invalid or outside of a permitted range.
121121
122-
@note This function may be called from ISR context if the millisec parameter is set to 0.
122+
@note You may call this function from ISR context if the millisec parameter is set to 0.
123123
*/
124124
osEvent get(uint32_t millisec=osWaitForever) {
125125
osEvent event;

0 commit comments

Comments
 (0)