Skip to content

Commit 57b7940

Browse files
author
Amanda Butler
authored
Edit EventFlags.h
Make minor copy edits to existing text.
1 parent e2b117f commit 57b7940

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

rtos/EventFlags.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ namespace rtos {
4343
EventFlags support 31 flags. The MSB flag is ignored. It is used to return an error code (@a osFlagsError).
4444
4545
@note
46-
Memory considerations: The EventFlags control structures will be created on current thread's stack, both for the Mbed OS
46+
Memory considerations: The EventFlags control structures will be created on the current thread's stack, both for the Mbed OS
4747
and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
4848
*/
4949
class EventFlags : private mbed::NonCopyable<EventFlags> {
@@ -54,7 +54,7 @@ class EventFlags : private mbed::NonCopyable<EventFlags> {
5454
*/
5555
EventFlags();
5656

57-
/** Create and initialize a EventFlags object.
57+
/** Create and initialize an EventFlags object.
5858
5959
@param name name to be used for this EventFlags. It has to stay allocated for the lifetime of the thread.
6060
@@ -63,15 +63,15 @@ class EventFlags : private mbed::NonCopyable<EventFlags> {
6363
EventFlags(const char *name);
6464

6565
/** Set the specified event flags.
66-
@param flags the flags that shall be set.
66+
@param flags the flags that will be set.
6767
@return event flags after setting or error code if highest bit set (see @a osFlagsError for details).
6868
6969
@note This function may be called from ISR context.
7070
*/
7171
uint32_t set(uint32_t flags);
7272

7373
/** Clear the specified event flags.
74-
@param flags the flags that shall be cleared (default: 0x7fffffff -- all flags).
74+
@param flags the flags that will be cleared (default: 0x7fffffff -- all flags).
7575
@return event flags before clearing or error code if highest bit set (see @a osFlagsError for details).
7676
7777
@note You may call this function from ISR context.
@@ -97,7 +97,7 @@ class EventFlags : private mbed::NonCopyable<EventFlags> {
9797

9898
/** Wait for any of the specified event flags to become signaled.
9999
@param flags the flags to wait for (default: 0 -- no flags).
100-
@param timeout timeout value or 0 in case of no time-out (default: osWaitForever).
100+
@param timeout timeout value or 0 in case of no timeout (default: osWaitForever).
101101
@param clear clear specified event flags after waiting for them (default: true).
102102
@return event flags before clearing or error code if highest bit set (see @a osFlagsError for details).
103103

0 commit comments

Comments
 (0)