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

events: Added better documentation for binding types to events

pull/3782/head
Christopher Haster 2017-02-17 14:33:09 -06:00
parent 99ca88a66a
commit 3531a1579e
2 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
events/Event.h
View File

@ -45,7 +45,10 @@ 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 a0..a4 Arguments to pass to the callback * @param c0..c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback.
*/ */
template <typename F> template <typename F>
Event(EventQueue *q, F f) { Event(EventQueue *q, F f) {
@ -438,7 +441,10 @@ 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 a0..a4 Arguments to pass to the callback * @param c0..c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback.
*/ */
template <typename F> template <typename F>
Event(EventQueue *q, F f) { Event(EventQueue *q, F f) {
@ -831,7 +837,10 @@ 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 a0..a4 Arguments to pass to the callback * @param c0..c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback.
*/ */
template <typename F> template <typename F>
Event(EventQueue *q, F f) { Event(EventQueue *q, F f) {
@ -1224,7 +1233,10 @@ 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 a0..a4 Arguments to pass to the callback * @param c0..c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback.
*/ */
template <typename F> template <typename F>
Event(EventQueue *q, F f) { Event(EventQueue *q, F f) {
@ -1617,7 +1629,10 @@ 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 a0..a4 Arguments to pass to the callback * @param c0..c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback.
*/ */
template <typename F> template <typename F>
Event(EventQueue *q, F f) { Event(EventQueue *q, F f) {
@ -2010,7 +2025,10 @@ 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 a0..a4 Arguments to pass to the callback * @param c0..c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback.
*/ */
template <typename F> template <typename F>
Event(EventQueue *q, F f) { Event(EventQueue *q, F f) {

5
events/EventQueue.h
View File

@ -944,7 +944,10 @@ public:
* context of the event queue's dispatch loop once posted. * context of the event queue's dispatch loop once posted.
* *
* @param f Function to execute when the event is dispatched * @param f Function to execute when the event is dispatched
* @param a0..a4 Arguments to pass to the callback * @param c0..c4 Arguments to bind to the callback, these arguments are
* allocated on an irq-safe allocator from the event queue's
* memory pool. Must be type-compatible with b0..b4, the
* arguments to the underlying callback.
* @return Event that will dispatch on the specific queue * @return Event that will dispatch on the specific queue
*/ */
template <typename R> template <typename R>