Skip to content

Commit dc54ac7

Browse files
Amanda Butleradbridge
Amanda Butler
authored and
adbridge
committed
Copy edit EventQueue.h
Copy edit file for consistent capitalization, tense and voice.
1 parent 3d1c259 commit dc54ac7

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
@@ -212,7 +212,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
212212
* // events are simple callbacks
213213
* queue.call(printf, "called immediately\n");
214214
*
215-
* // events are executed by the dispatch method
215+
* // the dispatch method executes events
216216
* queue.dispatch();
217217
* }
218218
* @endcode
@@ -222,19 +222,19 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
222222

223223
/** Calls an event on the queue
224224
*
225-
* The specified callback will be executed in the context of the event
225+
* The specified callback is executed in the context of the event
226226
* queue's dispatch loop.
227227
*
228-
* The call function is irq safe and can act as a mechanism for moving
229-
* events out of irq contexts.
228+
* The call function is IRQ safe and can act as a mechanism for moving
229+
* events out of IRQ contexts.
230230
*
231231
* @param obj Object to call with the member function
232232
* @param method Member function to execute in the context of the dispatch loop
233233
* @param args Arguments to pass to the callback
234-
* @return A unique id that represents the posted event and can
235-
* be passed to cancel, or an id of 0 if there is not
234+
* @return A unique ID that represents the posted event and can
235+
* be passed to cancel, or an ID of 0 if there is not
236236
* enough memory to allocate the event.
237-
* Returned id will remain valid until event has finished
237+
* Returned ID remains valid until event has finished
238238
* executing.
239239
*
240240
* @code
@@ -261,7 +261,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
261261
* // with provided parameter
262262
* queue.call(&handler_cb, &EventHandler::handler, 2);
263263
*
264-
* // events are executed by the dispatch method
264+
* // the dispath method executes events
265265
* queue.dispatch();
266266
* }
267267
* @endcode
@@ -271,16 +271,16 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
271271

272272
/** Calls an event on the queue after a specified delay
273273
*
274-
* The specified callback will be executed in the context of the event
274+
* The specified callback is executed in the context of the event
275275
* queue's dispatch loop.
276276
*
277-
* The call_in function is irq safe and can act as a mechanism for moving
278-
* events out of irq contexts.
277+
* The call_in function is IRQ safe and can act as a mechanism for moving
278+
* events out of IRQ contexts.
279279
*
280280
* @param ms Time to delay in milliseconds
281281
* @param args Arguments to pass to the callback
282-
* @return A unique id that represents the posted event and can
283-
* be passed to cancel, or an id of 0 if there is not
282+
* @return A unique ID that represents the posted event and can
283+
* be passed to cancel, or an ID of 0 if there is not
284284
* enough memory to allocate the event.
285285
*
286286
* @code
@@ -293,7 +293,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
293293
* // events are simple callbacks
294294
* queue.call_in(2000, printf, "called in 2 seconds\n");
295295
*
296-
* // events are executed by the dispatch method
296+
* // the dispatch methods executes events
297297
* queue.dispatch();
298298
* }
299299
* @endcode
@@ -303,18 +303,18 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
303303

304304
/** Calls an event on the queue after a specified delay
305305
*
306-
* The specified callback will be executed in the context of the event
306+
* The specified callback is executed in the context of the event
307307
* queue's dispatch loop.
308308
*
309-
* The call_in function is irq safe and can act as a mechanism for moving
310-
* events out of irq contexts.
309+
* The call_in function is IRQ safe and can act as a mechanism for moving
310+
* events out of IRQ contexts.
311311
*
312312
* @param ms Time to delay in milliseconds
313313
* @param obj Object to call with the member function
314314
* @param method Member function to execute in the context of the dispatch loop
315315
* @param args Arguments to pass to the callback
316-
* @return A unique id that represents the posted event and can
317-
* be passed to cancel, or an id of 0 if there is not
316+
* @return A unique ID that represents the posted event and can
317+
* be passed to cancel, or an ID of 0 if there is not
318318
* enough memory to allocate the event.
319319
*
320320
* @code
@@ -341,7 +341,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
341341
* // with provided parameter
342342
* queue.call_in(2000, &handler_cb, &EventHandler::handler, 4);
343343
*
344-
* // events are executed by the dispatch method
344+
* // the dispatch method executes events
345345
* queue.dispatch();
346346
* }
347347
* @endcode
@@ -354,17 +354,17 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
354354
* @note The first call_every event occurs after the specified delay.
355355
* To create a periodic event that fires immediately, @see Event.
356356
*
357-
* The specified callback will be executed in the context of the event
357+
* The specified callback is executed in the context of the event
358358
* queue's dispatch loop.
359359
*
360-
* The call_every function is irq safe and can act as a mechanism for
361-
* moving events out of irq contexts.
360+
* The call_every function is IRQ safe and can act as a mechanism for
361+
* moving events out of IRQ contexts.
362362
*
363363
* @param ms Period of the event in milliseconds
364364
* @param f Function to execute in the context of the dispatch loop
365365
* @param args Arguments to pass to the callback
366-
* @return A unique id that represents the posted event and can
367-
* be passed to cancel, or an id of 0 if there is not
366+
* @return A unique ID that represents the posted event and can
367+
* be passed to cancel, or an ID of 0 if there is not
368368
* enough memory to allocate the event.
369369
*
370370
* @code
@@ -387,7 +387,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
387387
* // events are simple callbacks, call every 2 seconds
388388
* queue.call_every(2000, printf, "Calling every 2 seconds\n");
389389
*
390-
* // events are executed by the dispatch method
390+
* // the dispatch method executes events
391391
* queue.dispatch();
392392
* }
393393
* @endcode
@@ -400,11 +400,11 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
400400
* @note The first call_every event occurs after the specified delay.
401401
* To create a periodic event that fires immediately, @see Event.
402402
*
403-
* The specified callback will be executed in the context of the event
403+
* The specified callback is executed in the context of the event
404404
* queue's dispatch loop.
405405
*
406-
* The call_every function is irq safe and can act as a mechanism for
407-
* moving events out of irq contexts.
406+
* The call_every function is IRQ safe and can act as a mechanism for
407+
* moving events out of IRQ contexts.
408408
*
409409
* @param ms Period of the event in milliseconds
410410
* @param obj Object to call with the member function
@@ -435,7 +435,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
435435
* // with provided parameter
436436
* queue.call_every(2000, &handler_cb, &EventHandler::handler, 6);
437437
*
438-
* // events are executed by the dispatch method
438+
* // the dispatch method executes events
439439
* queue.dispatch();
440440
* }
441441
* @endcode
@@ -451,7 +451,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
451451
*
452452
* @param func Function to execute when the event is dispatched
453453
* @param args Arguments to pass to the callback
454-
* @return Event that will dispatch on the specific queue
454+
* @return Event that dispatches on the specific queue
455455
*
456456
* @code
457457
* #include "mbed.h"
@@ -474,7 +474,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
474474
* // Post the event with paramter 8
475475
* e.post(8);
476476
*
477-
* // Events are executed by the dispatch method
477+
* // The dispatch method executes events
478478
* queue.dispatch();
479479
*
480480
* e2.post(2);
@@ -495,7 +495,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
495495
* @param obj Object to call with the member function
496496
* @param method Member function to execute in the context of the dispatch loop
497497
* @param context_args Arguments to pass to the callback
498-
* @return Event that will dispatch on the specific queue
498+
* @return Event that dispatches on the specific queue
499499
*
500500
* @code
501501
* #include "mbed.h"
@@ -523,7 +523,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
523523
* // Post the event with paramter 8
524524
* e.post(11);
525525
*
526-
* // Events are executed by the dispatch method
526+
* // The dispatch method executes events
527527
* queue.dispatch();
528528
* }
529529
* @endcode
@@ -539,7 +539,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
539539
*
540540
* @param cb Callback object
541541
* @param context_args Arguments to pass to the callback
542-
* @return Event that will dispatch on the specific queue
542+
* @return Event that dispatches on the specific queue
543543
*
544544
* @code
545545
* #include "mbed.h"
@@ -561,7 +561,7 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
561561
* // Post the event with parameter 8
562562
* e.post(9);
563563
*
564-
* // events are executed by the dispatch method
564+
* // The dispatch method executes events
565565
* q.dispatch();
566566
* }
567567
* @endcode
@@ -573,17 +573,17 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
573573

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

0 commit comments

Comments
 (0)