ST / ST_Events-old

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   HelloWorld_CCA01M1 HelloWorld_CCA02M1 CI-data-logger-server HelloWorld_CCA02M1 ... more

This is a fork of the events subdirectory of https://github.com/ARMmbed/mbed-os.

Note, you must import this library with import name: events!!!

Files at this revision

API Documentation at this revision

Revision 9822:fb4e93c12c32, committed 2017-04-04

Comitter:
Jimmy Brisson
Date:
Tue Apr 04 14:21:53 2017 -0500
Parent:
17:26f21b1871a7
Child:
9823:3e5679fe7fa6
Commit message:
Update class documentation tags

stop using scope for \addtogroup. It was placing class methods into the
group documentation instead of the class documentation. The new style is
to explicitly tag the class as @ingroup. This new method will allow the
class to be linked in the group page, and the class page will contain
the detailed documentation of the class methods.

Changed in this revision

Event.h Show annotated file Show diff for this revision Revisions of this file
EventQueue.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Event.h	Tue Feb 21 10:53:14 2017 -0600
+++ b/Event.h	Tue Apr 04 14:21:53 2017 -0500
@@ -21,11 +21,11 @@
 
 namespace events {
 /** \addtogroup events */
-/** @{*/
 
 /** Event
  *
  *  Representation of an event for fine-grain dispatch control
+ * @ingroup events
  */
 template <typename F>
 class Event;
@@ -33,6 +33,7 @@
 /** Event
  *
  *  Representation of an event for fine-grain dispatch control
+ * @ingroup events
  */
 template <>
 class Event<void()> {
@@ -429,6 +430,7 @@
 /** Event
  *
  *  Representation of an event for fine-grain dispatch control
+ * @ingroup events
  */
 template <typename A0>
 class Event<void(A0)> {
@@ -825,6 +827,7 @@
 /** Event
  *
  *  Representation of an event for fine-grain dispatch control
+ * @ingroup events
  */
 template <typename A0, typename A1>
 class Event<void(A0, A1)> {
@@ -1221,6 +1224,7 @@
 /** Event
  *
  *  Representation of an event for fine-grain dispatch control
+ * @ingroup events
  */
 template <typename A0, typename A1, typename A2>
 class Event<void(A0, A1, A2)> {
@@ -1617,6 +1621,7 @@
 /** Event
  *
  *  Representation of an event for fine-grain dispatch control
+ * @ingroup events
  */
 template <typename A0, typename A1, typename A2, typename A3>
 class Event<void(A0, A1, A2, A3)> {
@@ -2013,6 +2018,7 @@
 /** Event
  *
  *  Representation of an event for fine-grain dispatch control
+ * @ingroup events
  */
 template <typename A0, typename A1, typename A2, typename A3, typename A4>
 class Event<void(A0, A1, A2, A3, A4)> {
@@ -2407,6 +2413,8 @@
 };
 
 
+/** \addtogroup events */
+/** @{ */
 
 // Convenience functions declared here to avoid cyclic
 // dependency between Event and EventQueue

--- a/EventQueue.h	Tue Feb 21 10:53:14 2017 -0600
+++ b/EventQueue.h	Tue Apr 04 14:21:53 2017 -0500
@@ -24,7 +24,6 @@
 
 namespace events {
 /** \addtogroup events */
-/** @{*/
 
 /** EVENTS_EVENT_SIZE
  *  Minimum size of an event
@@ -46,6 +45,7 @@
 /** EventQueue
  *
  *  Flexible event queue for dispatching events
+ * @ingroup events
  */
 class EventQueue {
 public:
@@ -2698,4 +2698,3 @@
 
 #endif
 
-/** @}*/