ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #8652 from 0xc0170/dev_rollup 

Rollup PR for docs
pull/8672/head
Cruz Monrreal 2018-11-06 20:40:04 -06:00 committed by GitHub
parent 0c2d35f312 9d1aa738eb
commit c792d33112
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 92 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doxyfile_options
View File

@ -849,6 +849,7 @@ EXCLUDE_PATTERNS = */tools/* \
*/features/lwipstack/* \ */features/lwipstack/* \
*/features/nanostack/sal-stack-nanostack/* \ */features/nanostack/sal-stack-nanostack/* \
*/features/nanostack/coap-service/* \ */features/nanostack/coap-service/* \
*/features/netsocket/emac-drivers/* \
*/mbed-trace/* \ */mbed-trace/* \
*/mbed-coap/* \ */mbed-coap/* \
*/nanostack-libservice/* \ */nanostack-libservice/* \

96
events/Event.h
View File

@ -131,8 +131,8 @@ public:
* The event is posted to the underlying queue and is executed in the * The event is posted to the underlying queue and is executed in the
* context of the event queue's dispatch loop. * context of the event queue's dispatch loop.
* *
* The post function is irq safe and can act as a mechanism for moving * The post function is IRQ safe and can act as a mechanism for moving
* events out of irq contexts. * events out of IRQ contexts.
* *
* @return A unique id that represents the posted event and can * @return A unique id that represents the posted event and can
* be passed to EventQueue::cancel, or an id of 0 if * be passed to EventQueue::cancel, or an id of 0 if
@ -179,7 +179,7 @@ public:
* Attempts to cancel the most recently posted event. It is safe to call * Attempts to cancel the most recently posted event. It is safe to call
* cancel after an event has already been dispatched. * cancel after an event has already been dispatched.
* *
* The cancel function is irq safe. * The cancel function is IRQ safe.
* *
* If called while the event queue's dispatch loop is active, the cancel * If called while the event queue's dispatch loop is active, the cancel
* function does not guarantee that the event will not execute after it * function does not guarantee that the event will not execute after it
@ -235,7 +235,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0 Argument to bind to the callback, these arguments are * @param c0 Argument to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0, the * memory pool. Must be type-compatible with b0, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -249,7 +249,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1 Arguments to bind to the callback, these arguments are * @param c0,c1 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b1, the * memory pool. Must be type-compatible with b0..b1, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -263,7 +263,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2 Arguments to bind to the callback, these arguments are * @param c0,c1,c2 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b2, the * memory pool. Must be type-compatible with b0..b2, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -277,7 +277,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are * @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b3, the * memory pool. Must be type-compatible with b0..b3, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -291,7 +291,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2,c3,c4 Arguments to bind to the callback, these arguments are * @param c0,c1,c2,c3,c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the * memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -583,8 +583,8 @@ public:
* The event is posted to the underlying queue and is executed in the * The event is posted to the underlying queue and is executed in the
* context of the event queue's dispatch loop. * context of the event queue's dispatch loop.
* *
* The post function is irq safe and can act as a mechanism for moving * The post function is IRQ safe and can act as a mechanism for moving
* events out of irq contexts. * events out of IRQ contexts.
* *
* @param a0 Argument to pass to the event * @param a0 Argument to pass to the event
* @return A unique id that represents the posted event and can * @return A unique id that represents the posted event and can
@ -635,7 +635,7 @@ public:
* Attempts to cancel the most recently posted event. It is safe to call * Attempts to cancel the most recently posted event. It is safe to call
* cancel after an event has already been dispatched. * cancel after an event has already been dispatched.
* *
* The cancel function is irq safe. * The cancel function is IRQ safe.
* *
* If called while the event queue's dispatch loop is active, the cancel * If called while the event queue's dispatch loop is active, the cancel
* function does not guarantee that the event will not execute after it * function does not guarantee that the event will not execute after it
@ -691,7 +691,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0 Argument to bind to the callback, these arguments are * @param c0 Argument to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0, the * memory pool. Must be type-compatible with b0, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -705,7 +705,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1 Arguments to bind to the callback, these arguments are * @param c0,c1 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b1, the * memory pool. Must be type-compatible with b0..b1, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -719,7 +719,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2 Arguments to bind to the callback, these arguments are * @param c0,c1,c2 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b2, the * memory pool. Must be type-compatible with b0..b2, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -733,7 +733,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are * @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b3, the * memory pool. Must be type-compatible with b0..b3, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -747,7 +747,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2,c3,c4 Arguments to bind to the callback, these arguments are * @param c0,c1,c2,c3,c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the * memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -1039,8 +1039,8 @@ public:
* The event is posted to the underlying queue and is executed in the * The event is posted to the underlying queue and is executed in the
* context of the event queue's dispatch loop. * context of the event queue's dispatch loop.
* *
* The post function is irq safe and can act as a mechanism for moving * The post function is IRQ safe and can act as a mechanism for moving
* events out of irq contexts. * events out of IRQ contexts.
* *
* @param a0,a1 Arguments to pass to the event * @param a0,a1 Arguments to pass to the event
* @return A unique id that represents the posted event and can * @return A unique id that represents the posted event and can
@ -1091,7 +1091,7 @@ public:
* Attempts to cancel the most recently posted event. It is safe to call * Attempts to cancel the most recently posted event. It is safe to call
* cancel after an event has already been dispatched. * cancel after an event has already been dispatched.
* *
* The cancel function is irq safe. * The cancel function is IRQ safe.
* *
* If called while the event queue's dispatch loop is active, the cancel * If called while the event queue's dispatch loop is active, the cancel
* function does not guarantee that the event will not execute after it * function does not guarantee that the event will not execute after it
@ -1147,7 +1147,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0 Argument to bind to the callback, these arguments are * @param c0 Argument to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0, the * memory pool. Must be type-compatible with b0, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -1161,7 +1161,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1 Arguments to bind to the callback, these arguments are * @param c0,c1 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b1, the * memory pool. Must be type-compatible with b0..b1, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -1175,7 +1175,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2 Arguments to bind to the callback, these arguments are * @param c0,c1,c2 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b2, the * memory pool. Must be type-compatible with b0..b2, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -1189,7 +1189,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are * @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b3, the * memory pool. Must be type-compatible with b0..b3, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -1203,7 +1203,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2,c3,c4 Arguments to bind to the callback, these arguments are * @param c0,c1,c2,c3,c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the * memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -1495,8 +1495,8 @@ public:
* The event is posted to the underlying queue and is executed in the * The event is posted to the underlying queue and is executed in the
* context of the event queue's dispatch loop. * context of the event queue's dispatch loop.
* *
* The post function is irq safe and can act as a mechanism for moving * The post function is IRQ safe and can act as a mechanism for moving
* events out of irq contexts. * events out of IRQ contexts.
* *
* @param a0,a1,a2 Arguments to pass to the event * @param a0,a1,a2 Arguments to pass to the event
* @return A unique id that represents the posted event and can * @return A unique id that represents the posted event and can
@ -1547,7 +1547,7 @@ public:
* Attempts to cancel the most recently posted event. It is safe to call * Attempts to cancel the most recently posted event. It is safe to call
* cancel after an event has already been dispatched. * cancel after an event has already been dispatched.
* *
* The cancel function is irq safe. * The cancel function is IRQ safe.
* *
* If called while the event queue's dispatch loop is active, the cancel * If called while the event queue's dispatch loop is active, the cancel
* function does not guarantee that the event will not execute after it * function does not guarantee that the event will not execute after it
@ -1603,7 +1603,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0 Argument to bind to the callback, these arguments are * @param c0 Argument to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0, the * memory pool. Must be type-compatible with b0, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -1617,7 +1617,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1 Arguments to bind to the callback, these arguments are * @param c0,c1 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b1, the * memory pool. Must be type-compatible with b0..b1, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -1631,7 +1631,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2 Arguments to bind to the callback, these arguments are * @param c0,c1,c2 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b2, the * memory pool. Must be type-compatible with b0..b2, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -1645,7 +1645,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are * @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b3, the * memory pool. Must be type-compatible with b0..b3, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -1659,7 +1659,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2,c3,c4 Arguments to bind to the callback, these arguments are * @param c0,c1,c2,c3,c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the * memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -1951,8 +1951,8 @@ public:
* The event is posted to the underlying queue and is executed in the * The event is posted to the underlying queue and is executed in the
* context of the event queue's dispatch loop. * context of the event queue's dispatch loop.
* *
* The post function is irq safe and can act as a mechanism for moving * The post function is IRQ safe and can act as a mechanism for moving
* events out of irq contexts. * events out of IRQ contexts.
* *
* @param a0,a1,a2,a3 Arguments to pass to the event * @param a0,a1,a2,a3 Arguments to pass to the event
* @return A unique id that represents the posted event and can * @return A unique id that represents the posted event and can
@ -2003,7 +2003,7 @@ public:
* Attempts to cancel the most recently posted event. It is safe to call * Attempts to cancel the most recently posted event. It is safe to call
* cancel after an event has already been dispatched. * cancel after an event has already been dispatched.
* *
* The cancel function is irq safe. * The cancel function is IRQ safe.
* *
* If called while the event queue's dispatch loop is active, the cancel * If called while the event queue's dispatch loop is active, the cancel
* function does not guarantee that the event will not execute after it * function does not guarantee that the event will not execute after it
@ -2060,7 +2060,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0 Argument to bind to the callback, these arguments are * @param c0 Argument to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0, the * memory pool. Must be type-compatible with b0, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -2074,7 +2074,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1 Arguments to bind to the callback, these arguments are * @param c0,c1 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b1, the * memory pool. Must be type-compatible with b0..b1, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -2088,7 +2088,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2 Arguments to bind to the callback, these arguments are * @param c0,c1,c2 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b2, the * memory pool. Must be type-compatible with b0..b2, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -2102,7 +2102,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are * @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b3, the * memory pool. Must be type-compatible with b0..b3, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -2116,7 +2116,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2,c3,c4 Arguments to bind to the callback, these arguments are * @param c0,c1,c2,c3,c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the * memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -2408,8 +2408,8 @@ public:
* The event is posted to the underlying queue and is executed in the * The event is posted to the underlying queue and is executed in the
* context of the event queue's dispatch loop. * context of the event queue's dispatch loop.
* *
* The post function is irq safe and can act as a mechanism for moving * The post function is IRQ safe and can act as a mechanism for moving
* events out of irq contexts. * events out of IRQ contexts.
* *
* @param a0,a1,a2,a3,a4 Arguments to pass to the event * @param a0,a1,a2,a3,a4 Arguments to pass to the event
* @return A unique id that represents the posted event and can * @return A unique id that represents the posted event and can
@ -2460,7 +2460,7 @@ public:
* Attempts to cancel the most recently posted event. It is safe to call * Attempts to cancel the most recently posted event. It is safe to call
* cancel after an event has already been dispatched. * cancel after an event has already been dispatched.
* *
* The cancel function is irq safe. * The cancel function is IRQ safe.
* *
* If called while the event queue's dispatch loop is active, the cancel * If called while the event queue's dispatch loop is active, the cancel
* function does not guarantee that the event will not execute after it * function does not guarantee that the event will not execute after it
@ -2516,7 +2516,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0 Argument to bind to the callback, these arguments are * @param c0 Argument to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0, the * memory pool. Must be type-compatible with b0, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -2530,7 +2530,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1 Arguments to bind to the callback, these arguments are * @param c0,c1 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b1, the * memory pool. Must be type-compatible with b0..b1, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -2544,7 +2544,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2 Arguments to bind to the callback, these arguments are * @param c0,c1,c2 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b2, the * memory pool. Must be type-compatible with b0..b2, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -2558,7 +2558,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are * @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b3, the * memory pool. Must be type-compatible with b0..b3, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */
@ -2572,7 +2572,7 @@ public:
* @param q Event queue to dispatch on * @param q Event queue to dispatch on
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param c0,c1,c2,c3,c4 Arguments to bind to the callback, these arguments are * @param c0,c1,c2,c3,c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's * allocated on an IRQ-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the * memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback. * arguments to the underlying callback.
*/ */

18
events/EventQueue.h
View File

@ -74,7 +74,7 @@ public:
* *
* When called with a finite timeout, the dispatch function is guaranteed * When called with a finite timeout, the dispatch function is guaranteed
* to terminate. When called with a timeout of 0, the dispatch function * to terminate. When called with a timeout of 0, the dispatch function
* does not wait and is irq safe. * does not wait and is IRQ safe.
* *
* @param ms Time to wait for events in milliseconds, a negative * @param ms Time to wait for events in milliseconds, a negative
* value will dispatch events indefinitely * value will dispatch events indefinitely
@ -119,7 +119,7 @@ public:
* *
* id must be valid i.e. event must have not finished executing. * id must be valid i.e. event must have not finished executing.
* *
* The cancel function is irq safe. * The cancel function is IRQ safe.
* *
* If called while the event queue's dispatch loop is active, the cancel * If called while the event queue's dispatch loop is active, the cancel
* function does not guarantee that the event will not execute after it * function does not guarantee that the event will not execute after it
@ -136,7 +136,7 @@ public:
* *
* id must be valid i.e. event must have not finished executing. * id must be valid i.e. event must have not finished executing.
* *
* This function is irq safe. * This function is IRQ safe.
* *
* @param id Unique id of the event * @param id Unique id of the event
* *
@ -191,8 +191,8 @@ public:
* The specified callback will be executed in the context of the event * The specified callback will be executed in the context of the event
* queue's dispatch loop. * queue's dispatch loop.
* *
* The call function is irq safe and can act as a mechanism for moving * The call function is IRQ safe and can act as a mechanism for moving
* events out of irq contexts. * events out of IRQ contexts.
* *
* @param f Function to execute in the context of the dispatch loop * @param f Function to execute in the context of the dispatch loop
* @param args Arguments to pass to the callback * @param args Arguments to pass to the callback
@ -892,8 +892,8 @@ public:
* The specified callback will be executed in the context of the event * The specified callback will be executed in the context of the event
* queue's dispatch loop. * queue's dispatch loop.
* *
* The call_in function is irq safe and can act as a mechanism for moving * The call_in function is IRQ safe and can act as a mechanism for moving
* events out of irq contexts. * events out of IRQ contexts.
* *
* @param ms Time to delay in milliseconds * @param ms Time to delay in milliseconds
* @param f Function to execute in the context of the dispatch loop * @param f Function to execute in the context of the dispatch loop
@ -1199,8 +1199,8 @@ public:
* The specified callback will be executed in the context of the event * The specified callback will be executed in the context of the event
* queue's dispatch loop. * queue's dispatch loop.
* *
* The call_every function is irq safe and can act as a mechanism for * The call_every function is IRQ safe and can act as a mechanism for
* moving events out of irq contexts. * moving events out of IRQ contexts.
* *
* @param f Function to execute in the context of the dispatch loop * @param f Function to execute in the context of the dispatch loop
* @param ms Period of the event in milliseconds * @param ms Period of the event in milliseconds

6
events/mbed_shared_queues.h
View File

@ -41,9 +41,9 @@ namespace mbed {
* If an RTOS is not present or the configuration option * If an RTOS is not present or the configuration option
* `events.shared-dispatch-from-application` is set to true, then this * `events.shared-dispatch-from-application` is set to true, then this
* does not create a dedicated dispatch thread - instead the application is * does not create a dedicated dispatch thread - instead the application is
* expected to run the EventQueue's dispatch, eg from main. This is necessary * expected to run the EventQueue's dispatch, for example from main. This is
* for the event loop to work without an RTOS, or an RTOS system can can save * necessary for the event loop to work without an RTOS, or an RTOS system can
* memory by reusing the main stack. * save memory by reusing the main stack.
* *
* @note * @note
* mbed_event_queue is not itself IRQ safe. To use the mbed_event_queue in * mbed_event_queue is not itself IRQ safe. To use the mbed_event_queue in

5
features/netsocket/NetworkInterface.h
View File

@ -33,7 +33,8 @@ class EMACInterface;
/** Common interface that is shared between network devices. /** Common interface that is shared between network devices.
* *
* @addtogroup netsocket * @\addtogroup netsocket
* @{
*/ */
class NetworkInterface: public DNS { class NetworkInterface: public DNS {
public: public:
@ -331,5 +332,5 @@ protected:
#endif //!defined(DOXYGEN_ONLY) #endif //!defined(DOXYGEN_ONLY)
}; };
/** @}*/
#endif #endif

2
platform/CallChain.h
View File

@ -147,7 +147,7 @@ public:
* @param method pointer to the member function to be called * @param method pointer to the member function to be called
* *
* @returns * @returns
* The function object created for 'tptr' and 'mptr' * The function object created for the object and method pointers
* *
* @deprecated * @deprecated
* The add_front function does not support cv-qualifiers. Replaced by * The add_front function does not support cv-qualifiers. Replaced by

2
platform/SharedPtr.h
View File

@ -29,7 +29,7 @@ namespace mbed {
/** Shared pointer class. /** Shared pointer class.
* *
* A shared pointer is a "smart" pointer that retains ownership of an object using * A shared pointer is a "smart" pointer that retains ownership of an object using
* reference counting accross all smart pointers referencing that object. * reference counting across all smart pointers referencing that object.
* *
* @code * @code
* #include "platform/SharedPtr.h" * #include "platform/SharedPtr.h"

32
platform/mbed_error.h
View File

@ -86,24 +86,24 @@ extern "C" {
\endverbatim \endverbatim
* *
* The error status value range for each error type is as follows:\n * The error status value range for each error type is as follows:\n
* Posix Error Status-es - 0xFFFFFFFF to 0xFFFFFF01(-1 -255) - This corresponds to Posix error codes represented as negative.\n * POSIX Error Status-es - 0xFFFFFFFF to 0xFFFFFF01(-1 -255) - This corresponds to POSIX error codes represented as negative.\n
* System Error Status-es - 0x80XX0100 to 0x80XX0FFF - This corresponds to System error codes range(all values are negative). Bits 23-16 will be module type(marked with XX)\n * System Error Status-es - 0x80XX0100 to 0x80XX0FFF - This corresponds to System error codes range(all values are negative). Bits 23-16 will be module type(marked with XX)\n
* Custom Error Status-es - 0xA0XX1000 to 0xA0XXFFFF - This corresponds to Custom error codes range(all values are negative). Bits 23-16 will be module type(marked with XX)\n\n * Custom Error Status-es - 0xA0XX1000 to 0xA0XXFFFF - This corresponds to Custom error codes range(all values are negative). Bits 23-16 will be module type(marked with XX)\n\n
* *
* The ERROR CODE(values encoded into ERROR CODE bit-field in mbed_error_status_t) value range for each error type is also separated as below:\n * The ERROR CODE(values encoded into ERROR CODE bit-field in mbed_error_status_t) value range for each error type is also separated as below:\n
* Posix Error Codes - 1 to 255.\n * POSIX Error Codes - 1 to 255.\n
* System Error Codes - 256 to 4095.\n * System Error Codes - 256 to 4095.\n
* Custom Error Codes - 4096 to 65535.\n * Custom Error Codes - 4096 to 65535.\n
* *
* @note Posix error codes are always encoded as negative of their actual value. For example, EPERM is encoded as -EPERM. * @note POSIX error codes are always encoded as negative of their actual value. For example, EPERM is encoded as -EPERM.
* And, the MODULE TYPE for Posix error codes are always encoded as MBED_MODULE_UNKNOWN.\n * And, the MODULE TYPE for POSIX error codes are always encoded as MBED_MODULE_UNKNOWN.\n
* This is to enable easy injection of Posix error codes into MbedOS error handling system without altering the actual Posix error values.\n * This is to enable easy injection of POSIX error codes into MbedOS error handling system without altering the actual POSIX error values.\n
* Accordingly, Posix error codes are represented as -1 to -255 under MbedOS error status representation. * Accordingly, POSIX error codes are represented as -1 to -255 under MbedOS error status representation.
*/ */
typedef int mbed_error_status_t; typedef int mbed_error_status_t;
/** /**
* Macro for defining a Posix error status. This macro is mainly used to define Posix error values in mbed_error_code_t enumeration. * Macro for defining a POSIX error status. This macro is mainly used to define POSIX error values in mbed_error_code_t enumeration.
* @param error_name Name of the error without the ERROR_ prefix * @param error_name Name of the error without the ERROR_ prefix
* @param error_code Error code value to be used, must be between 1 and 255(inclusive). * @param error_code Error code value to be used, must be between 1 and 255(inclusive).
* *
@ -201,7 +201,7 @@ typedef int mbed_error_status_t;
* See mbed_error_status_t description for more info.\n * See mbed_error_status_t description for more info.\n
* MBED_ERROR_TYPE_SYSTEM - Used to indicate that the error status is of System defined Error type.\n * MBED_ERROR_TYPE_SYSTEM - Used to indicate that the error status is of System defined Error type.\n
* MBED_ERROR_TYPE_CUSTOM - Used to indicate that the error status is of Custom defined Error type.\n * MBED_ERROR_TYPE_CUSTOM - Used to indicate that the error status is of Custom defined Error type.\n
* MBED_ERROR_TYPE_POSIX - Used to indicate that the error status is of Posix error type.\n * MBED_ERROR_TYPE_POSIX - Used to indicate that the error status is of POSIX error type.\n
* *
*/ */
typedef enum _mbed_error_type_t { typedef enum _mbed_error_type_t {
@ -301,23 +301,23 @@ typedef enum _mbed_module_type {
/** mbed_error_code_t definition /** mbed_error_code_t definition
* *
* mbed_error_code_t enumeration defines the Error codes and Error status values for MBED_MODULE_UNKNOWN.\n * mbed_error_code_t enumeration defines the Error codes and Error status values for MBED_MODULE_UNKNOWN.\n
* It defines all of Posix Error Codes/Statuses and Mbed System Error Codes/Statuses.\n\n * It defines all of POSIX Error Codes/Statuses and Mbed System Error Codes/Statuses.\n\n
* *
* @note * @note
* Posix Error codes are defined using the macro MBED_DEFINE_POSIX_ERROR\n * POSIX Error codes are defined using the macro MBED_DEFINE_POSIX_ERROR\n
* For example MBED_DEFINE_POSIX_ERROR( EPERM, EPERM ). This effectively defines the following values:\n * For example MBED_DEFINE_POSIX_ERROR( EPERM, EPERM ). This effectively defines the following values:\n
* ERROR_CODE_EPERM = EPERM\n * ERROR_CODE_EPERM = EPERM\n
* ERROR_EPERM = -EPERM\n * ERROR_EPERM = -EPERM\n
* *
* Posix Error codes are defined using the macro MBED_DEFINE_POSIX_ERROR\n * POSIX Error codes are defined using the macro MBED_DEFINE_POSIX_ERROR\n
* For example MBED_DEFINE_POSIX_ERROR( EPERM, EPERM ). This macro defines the following values:\n * For example MBED_DEFINE_POSIX_ERROR( EPERM, EPERM ). This macro defines the following values:\n
* ERROR_CODE_EPERM = MBED_POSIX_ERROR_BASE+EPERM\n * ERROR_CODE_EPERM = MBED_POSIX_ERROR_BASE+EPERM\n
* ERROR_EPERM = -(MBED_POSIX_ERROR_BASE+EPERM)\n * ERROR_EPERM = -(MBED_POSIX_ERROR_BASE+EPERM)\n
* Its effectively equivalent to:\n * Its effectively equivalent to:\n
* ERROR_CODE_EPERM = 1\n * ERROR_CODE_EPERM = 1\n
* ERROR_EPERM = -1\n * ERROR_EPERM = -1\n
* All Posix error codes currently supported by MbedOS(defined in mbed_retarget.h) are defined using the MBED_DEFINE_POSIX_ERROR macro.\n\n * All POSIX error codes currently supported by MbedOS(defined in mbed_retarget.h) are defined using the MBED_DEFINE_POSIX_ERROR macro.\n\n
* Below are the Posic error codes and the description:\n * Below are the POSIX error codes and the description:\n
* \verbatim * \verbatim
EPERM 1 Operation not permitted EPERM 1 Operation not permitted
ENOENT 2 No such file or directory ENOENT 2 No such file or directory
@ -546,9 +546,9 @@ typedef enum _mbed_module_type {
* *
* @note * @note
* **Using error codes:** \n * **Using error codes:** \n
* Posix error codes may be used in modules/functions currently using Posix error codes and switching them to Mbed-OS error codes * POSIX error codes may be used in modules/functions currently using POSIX error codes and switching them to Mbed-OS error codes
* may cause interoperability issues. For example, some of the filesystem, network stack implementations may need to use * may cause interoperability issues. For example, some of the filesystem, network stack implementations may need to use
* Posix error codes in order to keep them compatible with other modules interfacing with them, and may continue to use Posix error codes. * POSIX error codes in order to keep them compatible with other modules interfacing with them, and may continue to use POSIX error codes.
* *
* In all other cases, like for any native development of Mbed-OS modules Mbed-OS error codes should be used. * In all other cases, like for any native development of Mbed-OS modules Mbed-OS error codes should be used.
* This makes it easy to use Mbed-OS error reporting/logging infrastructure and makes debugging error scenarios * This makes it easy to use Mbed-OS error reporting/logging infrastructure and makes debugging error scenarios
@ -576,7 +576,7 @@ typedef enum _mbed_module_type {
typedef enum _mbed_error_code { typedef enum _mbed_error_code {
//Below are POSIX ERROR CODE definitions, which starts at MBED_POSIX_ERROR_BASE(=0) //Below are POSIX ERROR CODE definitions, which starts at MBED_POSIX_ERROR_BASE(=0)
//POSIX ERROR CODE definitions starts at offset 0(MBED_POSIX_ERROR_BASE) to align them with actual Posix Error Code //POSIX ERROR CODE definitions starts at offset 0(MBED_POSIX_ERROR_BASE) to align them with actual POSIX Error Code
//defintions in mbed_retarget.h //defintions in mbed_retarget.h
// Error Name Error Code // Error Name Error Code
MBED_DEFINE_POSIX_ERROR(EPERM, EPERM), /* 1 Operation not permitted */ MBED_DEFINE_POSIX_ERROR(EPERM, EPERM), /* 1 Operation not permitted */

6
platform/mbed_mem_trace.h
View File

@ -80,13 +80,13 @@ void mbed_mem_trace_set_callback(mbed_mem_trace_cb_t cb);
void mbed_mem_trace_disable(); void mbed_mem_trace_disable();
/** /**
* Renable the memory trace output with the cb in use when disable was called * Re-enable the memory trace output with the cb in use when disable was called
*/ */
void mbed_mem_trace_enable(); void mbed_mem_trace_enable();
/** /**
* Trace lock. * Trace lock.
* @note Locking prevent recursive tracing of malloc/free inside relloc/calloc * @note Locking prevent recursive tracing of malloc/free inside realloc/calloc
*/ */
void mbed_mem_trace_lock(); void mbed_mem_trace_lock();
@ -141,7 +141,7 @@ void mbed_mem_trace_free(void *ptr, void *caller);
* *
* @param op identifies the memory operation ('m' for 'malloc', 'r' for 'realloc', * @param op identifies the memory operation ('m' for 'malloc', 'r' for 'realloc',
* 'c' for 'calloc' and 'f' for 'free'). * 'c' for 'calloc' and 'f' for 'free').
* @param res (base 16) is the result of the memor operation. This is always NULL * @param res (base 16) is the result of the memory operation. This is always NULL
* for 'free', since 'free' doesn't return anything. * for 'free', since 'free' doesn't return anything.
* @param caller (base 16) is the caller of the memory operation. Note that the value * @param caller (base 16) is the caller of the memory operation. Note that the value
* of 'caller' might be unreliable. * of 'caller' might be unreliable.

2
platform/mbed_stats.h
View File

@ -65,7 +65,7 @@ typedef struct {
uint32_t thread_id; /**< Identifier for the thread that owns the stack or 0 if representing accumulated statistics */ uint32_t thread_id; /**< Identifier for the thread that owns the stack or 0 if representing accumulated statistics */
uint32_t max_size; /**< Maximum number of bytes used on the stack since the thread was started */ uint32_t max_size; /**< Maximum number of bytes used on the stack since the thread was started */
uint32_t reserved_size; /**< Current number of bytes reserved for the stack */ uint32_t reserved_size; /**< Current number of bytes reserved for the stack */
uint32_t stack_cnt; /**< The number of stacks represented in the accumulated statistics or 1 if repesenting a single stack */ uint32_t stack_cnt; /**< The number of stacks represented in the accumulated statistics or 1 if representing a single stack */
} mbed_stats_stack_t; } mbed_stats_stack_t;
/** /**

4
platform/mbed_toolchain.h
View File

@ -237,8 +237,8 @@
/** MBED_UNREACHABLE /** MBED_UNREACHABLE
* An unreachable statement. If the statement is reached, * An unreachable statement. If the statement is reached,
* behaviour is undefined. Useful in situations where the compiler * behavior is undefined. Useful in situations where the compiler
* cannot deduce the unreachability of code. * cannot deduce if the code is unreachable.
* *
* @code * @code
* #include "mbed_toolchain.h" * #include "mbed_toolchain.h"

2
rtos/Queue.h
View File

@ -37,7 +37,7 @@ namespace rtos {
*/ */
/** The Queue class represents a collection of objects that are stored first by /** The Queue class represents a collection of objects that are stored first by
* order of priorty, and then in first-in, first-out (FIFO) order. * order of priority, and then in first-in, first-out (FIFO) order.
* *
* You can use a queue when you need to store data and then access it in the same * You can use a queue when you need to store data and then access it in the same
* order that it has been stored. The order in which you retrieve the data is in * order that it has been stored. The order in which you retrieve the data is in

6
rtos/RtosTimer.h
View File

@ -88,7 +88,7 @@ class RtosTimer : private mbed::NonCopyable<RtosTimer> {
public: public:
/** Create timer. /** Create timer.
@param func function to be executed by this timer. @param func function to be executed by this timer.
@param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic) @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behavior. (default: osTimerPeriodic)
@param argument argument to the timer call back function. (default: NULL) @param argument argument to the timer call back function. (default: NULL)
@deprecated Replaced with RtosTimer(Callback<void()>, os_timer_type) @deprecated Replaced with RtosTimer(Callback<void()>, os_timer_type)
@deprecated @deprecated
@ -107,7 +107,7 @@ public:
/** Create timer. /** Create timer.
@param func function to be executed by this timer. @param func function to be executed by this timer.
@param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic) @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behavior. (default: osTimerPeriodic)
@deprecated @deprecated
The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details
@ -123,7 +123,7 @@ public:
/** Create timer. /** Create timer.
@param obj pointer to the object to call the member function on. @param obj pointer to the object to call the member function on.
@param method member function to be executed by this timer. @param method member function to be executed by this timer.
@param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic) @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behavior. (default: osTimerPeriodic)
@deprecated @deprecated
The RtosTimer constructor does not support cv-qualifiers. Replaced by The RtosTimer constructor does not support cv-qualifiers. Replaced by
RtosTimer(callback(obj, method), os_timer_type). RtosTimer(callback(obj, method), os_timer_type).