Skip to content

Commit 935db68

Browse files
author
Amanda Butler
authored
Copy edit EventQueue.h
Copy edit file for consistent capitalization, tense and voice.
1 parent 383b464 commit 935db68

File tree

1 file changed

+42
-42
lines changed

1 file changed

+42
-42
lines changed

‎events/EventQueue.h

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
209209
* // events are simple callbacks
210210
* queue.call(printf, "called immediately\n");
211211
*
212-
* // events are executed by the dispatch method
212+
* // the dispatch method executes events
213213
* queue.dispatch();
214214
* }
215215
* @endcode
@@ -219,19 +219,19 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
219219

220220
/** Calls an event on the queue
221221
*
222-
* The specified callback will be executed in the context of the event
222+
* The specified callback is executed in the context of the event
223223
* queue's dispatch loop.
224224
*
225-
* The call function is irq safe and can act as a mechanism for moving
226-
* events out of irq contexts.
225+
* The call function is IRQ safe and can act as a mechanism for moving
226+
* events out of IRQ contexts.
227227
*
228228
* @param obj Object to call with the member function
229229
* @param method Member function to execute in the context of the dispatch loop
230230
* @param args Arguments to pass to the callback
231-
* @return A unique id that represents the posted event and can
232-
* be passed to cancel, or an id of 0 if there is not
231+
* @return A unique ID that represents the posted event and can
232+
* be passed to cancel, or an ID of 0 if there is not
233233
* enough memory to allocate the event.
234-
* Returned id will remain valid until event has finished
234+
* Returned ID remains valid until event has finished
235235
* executing.
236236
*
237237
* @code
@@ -258,7 +258,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
258258
* // with provided parameter
259259
* queue.call(&handler_cb, &EventHandler::handler, 2);
260260
*
261-
* // events are executed by the dispatch method
261+
* // the dispath method executes events
262262
* queue.dispatch();
263263
* }
264264
* @endcode
@@ -268,16 +268,16 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
268268

269269
/** Calls an event on the queue after a specified delay
270270
*
271-
* The specified callback will be executed in the context of the event
271+
* The specified callback is executed in the context of the event
272272
* queue's dispatch loop.
273273
*
274-
* The call_in function is irq safe and can act as a mechanism for moving
275-
* events out of irq contexts.
274+
* The call_in function is IRQ safe and can act as a mechanism for moving
275+
* events out of IRQ contexts.
276276
*
277277
* @param ms Time to delay in milliseconds
278278
* @param args Arguments to pass to the callback
279-
* @return A unique id that represents the posted event and can
280-
* be passed to cancel, or an id of 0 if there is not
279+
* @return A unique ID that represents the posted event and can
280+
* be passed to cancel, or an ID of 0 if there is not
281281
* enough memory to allocate the event.
282282
*
283283
* @code
@@ -290,7 +290,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
290290
* // events are simple callbacks
291291
* queue.call_in(2000, printf, "called in 2 seconds\n");
292292
*
293-
* // events are executed by the dispatch method
293+
* // the dispatch methods executes events
294294
* queue.dispatch();
295295
* }
296296
* @endcode
@@ -300,18 +300,18 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
300300

301301
/** Calls an event on the queue after a specified delay
302302
*
303-
* The specified callback will be executed in the context of the event
303+
* The specified callback is executed in the context of the event
304304
* queue's dispatch loop.
305305
*
306-
* The call_in function is irq safe and can act as a mechanism for moving
307-
* events out of irq contexts.
306+
* The call_in function is IRQ safe and can act as a mechanism for moving
307+
* events out of IRQ contexts.
308308
*
309309
* @param ms Time to delay in milliseconds
310310
* @param obj Object to call with the member function
311311
* @param method Member function to execute in the context of the dispatch loop
312312
* @param args Arguments to pass to the callback
313-
* @return A unique id that represents the posted event and can
314-
* be passed to cancel, or an id of 0 if there is not
313+
* @return A unique ID that represents the posted event and can
314+
* be passed to cancel, or an ID of 0 if there is not
315315
* enough memory to allocate the event.
316316
*
317317
* @code
@@ -338,7 +338,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
338338
* // with provided parameter
339339
* queue.call_in(2000, &handler_cb, &EventHandler::handler, 4);
340340
*
341-
* // events are executed by the dispatch method
341+
* // the dispatch method executes events
342342
* queue.dispatch();
343343
* }
344344
* @endcode
@@ -351,17 +351,17 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
351351
* @note The first call_every event occurs after the specified delay.
352352
* To create a periodic event that fires immediately, @see Event.
353353
*
354-
* The specified callback will be executed in the context of the event
354+
* The specified callback is executed in the context of the event
355355
* queue's dispatch loop.
356356
*
357-
* The call_every function is irq safe and can act as a mechanism for
358-
* moving events out of irq contexts.
357+
* The call_every function is IRQ safe and can act as a mechanism for
358+
* moving events out of IRQ contexts.
359359
*
360360
* @param ms Period of the event in milliseconds
361361
* @param f Function to execute in the context of the dispatch loop
362362
* @param args Arguments to pass to the callback
363-
* @return A unique id that represents the posted event and can
364-
* be passed to cancel, or an id of 0 if there is not
363+
* @return A unique ID that represents the posted event and can
364+
* be passed to cancel, or an ID of 0 if there is not
365365
* enough memory to allocate the event.
366366
*
367367
* @code
@@ -384,7 +384,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
384384
* // events are simple callbacks, call every 2 seconds
385385
* queue.call_every(2000, printf, "Calling every 2 seconds\n");
386386
*
387-
* // events are executed by the dispatch method
387+
* // the dispatch method executes events
388388
* queue.dispatch();
389389
* }
390390
* @endcode
@@ -397,11 +397,11 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
397397
* @note The first call_every event occurs after the specified delay.
398398
* To create a periodic event that fires immediately, @see Event.
399399
*
400-
* The specified callback will be executed in the context of the event
400+
* The specified callback is executed in the context of the event
401401
* queue's dispatch loop.
402402
*
403-
* The call_every function is irq safe and can act as a mechanism for
404-
* moving events out of irq contexts.
403+
* The call_every function is IRQ safe and can act as a mechanism for
404+
* moving events out of IRQ contexts.
405405
*
406406
* @param ms Period of the event in milliseconds
407407
* @param obj Object to call with the member function
@@ -432,7 +432,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
432432
* // with provided parameter
433433
* queue.call_every(2000, &handler_cb, &EventHandler::handler, 6);
434434
*
435-
* // events are executed by the dispatch method
435+
* // the dispatch method executes events
436436
* queue.dispatch();
437437
* }
438438
* @endcode
@@ -448,7 +448,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
448448
*
449449
* @param func Function to execute when the event is dispatched
450450
* @param args Arguments to pass to the callback
451-
* @return Event that will dispatch on the specific queue
451+
* @return Event that dispatches on the specific queue
452452
*
453453
* @code
454454
* #include "mbed.h"
@@ -471,7 +471,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
471471
* // Post the event with paramter 8
472472
* e.post(8);
473473
*
474-
* // Events are executed by the dispatch method
474+
* // The dispatch method executes events
475475
* queue.dispatch();
476476
*
477477
* e2.post(2);
@@ -492,7 +492,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
492492
* @param obj Object to call with the member function
493493
* @param method Member function to execute in the context of the dispatch loop
494494
* @param context_args Arguments to pass to the callback
495-
* @return Event that will dispatch on the specific queue
495+
* @return Event that dispatches on the specific queue
496496
*
497497
* @code
498498
* #include "mbed.h"
@@ -520,7 +520,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
520520
* // Post the event with paramter 8
521521
* e.post(11);
522522
*
523-
* // Events are executed by the dispatch method
523+
* // The dispatch method executes events
524524
* queue.dispatch();
525525
* }
526526
* @endcode
@@ -536,7 +536,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
536536
*
537537
* @param cb Callback object
538538
* @param context_args Arguments to pass to the callback
539-
* @return Event that will dispatch on the specific queue
539+
* @return Event that dispatches on the specific queue
540540
*
541541
* @code
542542
* #include "mbed.h"
@@ -558,7 +558,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
558558
* // Post the event with parameter 8
559559
* e.post(9);
560560
*
561-
* // events are executed by the dispatch method
561+
* // The dispatch method executes events
562562
* q.dispatch();
563563
* }
564564
* @endcode
@@ -570,17 +570,17 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
570570

571571
/** Calls an event on the queue
572572
*
573-
* The specified callback will be executed in the context of the event
573+
* The specified callback is executed in the context of the event
574574
* queue's dispatch loop.
575575
*
576-
* The call function is irq safe and can act as a mechanism for moving
577-
* events out of irq contexts.
576+
* The call function is IRQ safe and can act as a mechanism for moving
577+
* events out of IRQ contexts.
578578
*
579579
* @param f Function to execute in the context of the dispatch loop
580-
* @return A unique id that represents the posted event and can
581-
* be passed to cancel, or an id of 0 if there is not
580+
* @return A unique ID that represents the posted event and can
581+
* be passed to cancel, or an ID of 0 if there is not
582582
* enough memory to allocate the event.
583-
* Returned id will remain valid until event has finished
583+
* Returned ID remains valid until event has finished
584584
* executing.
585585
*
586586
* @code

0 commit comments

Comments
 (0)