events: Added better documentation for binding types to events

Author: geky

events/Event.h

@@ -45,7 +45,10 @@ class Event<void()> {
      *
      *  @param q        Event queue to dispatch on
      *  @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>
     Event(EventQueue *q, F f) {
@@ -438,7 +441,10 @@ class Event<void(A0)> {
      *
      *  @param q        Event queue to dispatch on
      *  @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>
     Event(EventQueue *q, F f) {
@@ -831,7 +837,10 @@ class Event<void(A0, A1)> {
      *
      *  @param q        Event queue to dispatch on
      *  @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>
     Event(EventQueue *q, F f) {
@@ -1224,7 +1233,10 @@ class Event<void(A0, A1, A2)> {
      *
      *  @param q        Event queue to dispatch on
      *  @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>
     Event(EventQueue *q, F f) {
@@ -1617,7 +1629,10 @@ class Event<void(A0, A1, A2, A3)> {
      *
      *  @param q        Event queue to dispatch on
      *  @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>
     Event(EventQueue *q, F f) {
@@ -2010,7 +2025,10 @@ class Event<void(A0, A1, A2, A3, A4)> {
      *
      *  @param q        Event queue to dispatch on
      *  @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>
     Event(EventQueue *q, F f) {

events/EventQueue.h

@@ -944,7 +944,10 @@ class EventQueue {
      *  context of the event queue's dispatch loop once posted.
      *
      *  @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
      */
     template <typename R>