@@ -43,7 +43,7 @@ namespace rtos {
43
43
EventFlags support 31 flags. The MSB flag is ignored. It is used to return an error code (@a osFlagsError).
44
44
45
45
@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
47
47
and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
48
48
*/
49
49
class EventFlags : private mbed ::NonCopyable<EventFlags> {
@@ -54,7 +54,7 @@ class EventFlags : private mbed::NonCopyable<EventFlags> {
54
54
*/
55
55
EventFlags ();
56
56
57
- /* * Create and initialize a EventFlags object.
57
+ /* * Create and initialize an EventFlags object.
58
58
59
59
@param name name to be used for this EventFlags. It has to stay allocated for the lifetime of the thread.
60
60
@@ -63,15 +63,15 @@ class EventFlags : private mbed::NonCopyable<EventFlags> {
63
63
EventFlags (const char *name);
64
64
65
65
/* * Set the specified event flags.
66
- @param flags the flags that shall be set.
66
+ @param flags the flags that will be set.
67
67
@return event flags after setting or error code if highest bit set (see @a osFlagsError for details).
68
68
69
69
@note This function may be called from ISR context.
70
70
*/
71
71
uint32_t set (uint32_t flags);
72
72
73
73
/* * 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).
75
75
@return event flags before clearing or error code if highest bit set (see @a osFlagsError for details).
76
76
77
77
@note You may call this function from ISR context.
@@ -97,7 +97,7 @@ class EventFlags : private mbed::NonCopyable<EventFlags> {
97
97
98
98
/* * Wait for any of the specified event flags to become signaled.
99
99
@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).
101
101
@param clear clear specified event flags after waiting for them (default: true).
102
102
@return event flags before clearing or error code if highest bit set (see @a osFlagsError for details).
103
103
0 commit comments