Skip to content

Commit 66b0ee2

Browse files
gekygeky
committed
Removed template walls
By selectively removing doxygen comments, we can present only the useful function documentation to users. Note that in C++11 these would just be vararg functions. In: - EventQueue.h - call - call_in - call_every - event - Event - constructor - Callback - constructor - attach - callback
1 parent d160cc6 commit 66b0ee2

File tree

3 files changed

+554
-467
lines changed

3 files changed

+554
-467
lines changed

‎events/Event.h

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@
2222
namespace events {
2323
/** \addtogroup events */
2424

25-
/** Event
25+
/* Event
2626
*
2727
* Representation of an event for fine-grain dispatch control
2828
* @ingroup events
2929
*/
3030
template <typename F>
3131
class Event;
3232

33-
/** Event
33+
/* Event
3434
*
3535
* Representation of an event for fine-grain dispatch control
3636
* @ingroup events
@@ -444,7 +444,7 @@ class Event<void()> {
444444
}
445445
};
446446

447-
/** Event
447+
/* Event
448448
*
449449
* Representation of an event for fine-grain dispatch control
450450
* @ingroup events
@@ -862,7 +862,7 @@ class Event<void(A0)> {
862862
}
863863
};
864864

865-
/** Event
865+
/* Event
866866
*
867867
* Representation of an event for fine-grain dispatch control
868868
* @ingroup events
@@ -1280,7 +1280,7 @@ class Event<void(A0, A1)> {
12801280
}
12811281
};
12821282

1283-
/** Event
1283+
/* Event
12841284
*
12851285
* Representation of an event for fine-grain dispatch control
12861286
* @ingroup events
@@ -1698,7 +1698,7 @@ class Event<void(A0, A1, A2)> {
16981698
}
16991699
};
17001700

1701-
/** Event
1701+
/* Event
17021702
*
17031703
* Representation of an event for fine-grain dispatch control
17041704
* @ingroup events
@@ -2308,7 +2308,7 @@ class Event<void(A0, A1, A2, A3, A4)> {
23082308
}
23092309

23102310
public:
2311-
/** Create an event
2311+
/* Create an event
23122312
* @param q Event queue to dispatch on
23132313
* @param f Function to execute when the event is dispatched
23142314
* @param c0 Argument to bind to the callback, these arguments are
@@ -2321,7 +2321,7 @@ class Event<void(A0, A1, A2, A3, A4)> {
23212321
new (this) Event(q, EventQueue::context15<F, C0, A0, A1, A2, A3, A4>(f, c0));
23222322
}
23232323

2324-
/** Create an event
2324+
/* Create an event
23252325
* @param q Event queue to dispatch on
23262326
* @param f Function to execute when the event is dispatched
23272327
* @param c0,c1 Arguments to bind to the callback, these arguments are
@@ -2334,7 +2334,7 @@ class Event<void(A0, A1, A2, A3, A4)> {
23342334
new (this) Event(q, EventQueue::context25<F, C0, C1, A0, A1, A2, A3, A4>(f, c0, c1));
23352335
}
23362336

2337-
/** Create an event
2337+
/* Create an event
23382338
* @param q Event queue to dispatch on
23392339
* @param f Function to execute when the event is dispatched
23402340
* @param c0,c1,c2 Arguments to bind to the callback, these arguments are
@@ -2347,7 +2347,7 @@ class Event<void(A0, A1, A2, A3, A4)> {
23472347
new (this) Event(q, EventQueue::context35<F, C0, C1, C2, A0, A1, A2, A3, A4>(f, c0, c1, c2));
23482348
}
23492349

2350-
/** Create an event
2350+
/* Create an event
23512351
* @param q Event queue to dispatch on
23522352
* @param f Function to execute when the event is dispatched
23532353
* @param c0,c1,c2,c3 Arguments to bind to the callback, these arguments are
@@ -2373,127 +2373,127 @@ class Event<void(A0, A1, A2, A3, A4)> {
23732373
new (this) Event(q, EventQueue::context55<F, C0, C1, C2, C3, C4, A0, A1, A2, A3, A4>(f, c0, c1, c2, c3, c4));
23742374
}
23752375

2376-
/** Create an event
2376+
/* Create an event
23772377
* @see Event::Event
23782378
*/
23792379
template <typename T, typename R, typename B0>
23802380
Event(EventQueue *q, T *obj, R (T::*method)(B0, A0, A1, A2, A3, A4), B0 b0) {
23812381
new (this) Event(q, mbed::callback(obj, method), b0);
23822382
}
23832383

2384-
/** Create an event
2384+
/* Create an event
23852385
* @see Event::Event
23862386
*/
23872387
template <typename T, typename R, typename B0>
23882388
Event(EventQueue *q, const T *obj, R (T::*method)(B0, A0, A1, A2, A3, A4) const, B0 b0) {
23892389
new (this) Event(q, mbed::callback(obj, method), b0);
23902390
}
23912391

2392-
/** Create an event
2392+
/* Create an event
23932393
* @see Event::Event
23942394
*/
23952395
template <typename T, typename R, typename B0>
23962396
Event(EventQueue *q, volatile T *obj, R (T::*method)(B0, A0, A1, A2, A3, A4) volatile, B0 b0) {
23972397
new (this) Event(q, mbed::callback(obj, method), b0);
23982398
}
23992399

2400-
/** Create an event
2400+
/* Create an event
24012401
* @see Event::Event
24022402
*/
24032403
template <typename T, typename R, typename B0>
24042404
Event(EventQueue *q, const volatile T *obj, R (T::*method)(B0, A0, A1, A2, A3, A4) const volatile, B0 b0) {
24052405
new (this) Event(q, mbed::callback(obj, method), b0);
24062406
}
24072407

2408-
/** Create an event
2408+
/* Create an event
24092409
* @see Event::Event
24102410
*/
24112411
template <typename T, typename R, typename B0, typename B1>
24122412
Event(EventQueue *q, T *obj, R (T::*method)(B0, B1, A0, A1, A2, A3, A4), B0 b0, B1 b1) {
24132413
new (this) Event(q, mbed::callback(obj, method), b0, b1);
24142414
}
24152415

2416-
/** Create an event
2416+
/* Create an event
24172417
* @see Event::Event
24182418
*/
24192419
template <typename T, typename R, typename B0, typename B1>
24202420
Event(EventQueue *q, const T *obj, R (T::*method)(B0, B1, A0, A1, A2, A3, A4) const, B0 b0, B1 b1) {
24212421
new (this) Event(q, mbed::callback(obj, method), b0, b1);
24222422
}
24232423

2424-
/** Create an event
2424+
/* Create an event
24252425
* @see Event::Event
24262426
*/
24272427
template <typename T, typename R, typename B0, typename B1>
24282428
Event(EventQueue *q, volatile T *obj, R (T::*method)(B0, B1, A0, A1, A2, A3, A4) volatile, B0 b0, B1 b1) {
24292429
new (this) Event(q, mbed::callback(obj, method), b0, b1);
24302430
}
24312431

2432-
/** Create an event
2432+
/* Create an event
24332433
* @see Event::Event
24342434
*/
24352435
template <typename T, typename R, typename B0, typename B1>
24362436
Event(EventQueue *q, const volatile T *obj, R (T::*method)(B0, B1, A0, A1, A2, A3, A4) const volatile, B0 b0, B1 b1) {
24372437
new (this) Event(q, mbed::callback(obj, method), b0, b1);
24382438
}
24392439

2440-
/** Create an event
2440+
/* Create an event
24412441
* @see Event::Event
24422442
*/
24432443
template <typename T, typename R, typename B0, typename B1, typename B2>
24442444
Event(EventQueue *q, T *obj, R (T::*method)(B0, B1, B2, A0, A1, A2, A3, A4), B0 b0, B1 b1, B2 b2) {
24452445
new (this) Event(q, mbed::callback(obj, method), b0, b1, b2);
24462446
}
24472447

2448-
/** Create an event
2448+
/* Create an event
24492449
* @see Event::Event
24502450
*/
24512451
template <typename T, typename R, typename B0, typename B1, typename B2>
24522452
Event(EventQueue *q, const T *obj, R (T::*method)(B0, B1, B2, A0, A1, A2, A3, A4) const, B0 b0, B1 b1, B2 b2) {
24532453
new (this) Event(q, mbed::callback(obj, method), b0, b1, b2);
24542454
}
24552455

2456-
/** Create an event
2456+
/* Create an event
24572457
* @see Event::Event
24582458
*/
24592459
template <typename T, typename R, typename B0, typename B1, typename B2>
24602460
Event(EventQueue *q, volatile T *obj, R (T::*method)(B0, B1, B2, A0, A1, A2, A3, A4) volatile, B0 b0, B1 b1, B2 b2) {
24612461
new (this) Event(q, mbed::callback(obj, method), b0, b1, b2);
24622462
}
24632463

2464-
/** Create an event
2464+
/* Create an event
24652465
* @see Event::Event
24662466
*/
24672467
template <typename T, typename R, typename B0, typename B1, typename B2>
24682468
Event(EventQueue *q, const volatile T *obj, R (T::*method)(B0, B1, B2, A0, A1, A2, A3, A4) const volatile, B0 b0, B1 b1, B2 b2) {
24692469
new (this) Event(q, mbed::callback(obj, method), b0, b1, b2);
24702470
}
24712471

2472-
/** Create an event
2472+
/* Create an event
24732473
* @see Event::Event
24742474
*/
24752475
template <typename T, typename R, typename B0, typename B1, typename B2, typename B3>
24762476
Event(EventQueue *q, T *obj, R (T::*method)(B0, B1, B2, B3, A0, A1, A2, A3, A4), B0 b0, B1 b1, B2 b2, B3 b3) {
24772477
new (this) Event(q, mbed::callback(obj, method), b0, b1, b2, b3);
24782478
}
24792479

2480-
/** Create an event
2480+
/* Create an event
24812481
* @see Event::Event
24822482
*/
24832483
template <typename T, typename R, typename B0, typename B1, typename B2, typename B3>
24842484
Event(EventQueue *q, const T *obj, R (T::*method)(B0, B1, B2, B3, A0, A1, A2, A3, A4) const, B0 b0, B1 b1, B2 b2, B3 b3) {
24852485
new (this) Event(q, mbed::callback(obj, method), b0, b1, b2, b3);
24862486
}
24872487

2488-
/** Create an event
2488+
/* Create an event
24892489
* @see Event::Event
24902490
*/
24912491
template <typename T, typename R, typename B0, typename B1, typename B2, typename B3>
24922492
Event(EventQueue *q, volatile T *obj, R (T::*method)(B0, B1, B2, B3, A0, A1, A2, A3, A4) volatile, B0 b0, B1 b1, B2 b2, B3 b3) {
24932493
new (this) Event(q, mbed::callback(obj, method), b0, b1, b2, b3);
24942494
}
24952495

2496-
/** Create an event
2496+
/* Create an event
24972497
* @see Event::Event
24982498
*/
24992499
template <typename T, typename R, typename B0, typename B1, typename B2, typename B3>
@@ -2502,30 +2502,36 @@ class Event<void(A0, A1, A2, A3, A4)> {
25022502
}
25032503

25042504
/** Create an event
2505-
* @see Event::Event
2505+
* @param q Event queue to dispatch on
2506+
* @param obj Object to execute the member function on
2507+
* @param method Member function to execute when the event is dispatched
2508+
* @param b0,b1,b2,b3,b4 Arguments to bind to the callback, these arguments are
2509+
* allocated on an irq-safe allocator from the event queue's
2510+
* memory pool. Must be type-compatible with b0..b4, the
2511+
* arguments to the underlying callback.
25062512
*/
25072513
template <typename T, typename R, typename B0, typename B1, typename B2, typename B3, typename B4>
25082514
Event(EventQueue *q, T *obj, R (T::*method)(B0, B1, B2, B3, B4, A0, A1, A2, A3, A4), B0 b0, B1 b1, B2 b2, B3 b3, B4 b4) {
25092515
new (this) Event(q, mbed::callback(obj, method), b0, b1, b2, b3, b4);
25102516
}
25112517

2512-
/** Create an event
2518+
/* Create an event
25132519
* @see Event::Event
25142520
*/
25152521
template <typename T, typename R, typename B0, typename B1, typename B2, typename B3, typename B4>
25162522
Event(EventQueue *q, const T *obj, R (T::*method)(B0, B1, B2, B3, B4, A0, A1, A2, A3, A4) const, B0 b0, B1 b1, B2 b2, B3 b3, B4 b4) {
25172523
new (this) Event(q, mbed::callback(obj, method), b0, b1, b2, b3, b4);
25182524
}
25192525

2520-
/** Create an event
2526+
/* Create an event
25212527
* @see Event::Event
25222528
*/
25232529
template <typename T, typename R, typename B0, typename B1, typename B2, typename B3, typename B4>
25242530
Event(EventQueue *q, volatile T *obj, R (T::*method)(B0, B1, B2, B3, B4, A0, A1, A2, A3, A4) volatile, B0 b0, B1 b1, B2 b2, B3 b3, B4 b4) {
25252531
new (this) Event(q, mbed::callback(obj, method), b0, b1, b2, b3, b4);
25262532
}
25272533

2528-
/** Create an event
2534+
/* Create an event
25292535
* @see Event::Event
25302536
*/
25312537
template <typename T, typename R, typename B0, typename B1, typename B2, typename B3, typename B4>

0 commit comments

Comments
 (0)