Clean up events (#3)

* Move private stuff into internal dir

* Fix relative paths

* Add Doxygen

* Update copyright

Author: gpsimenos

events/Event.h

@@ -1,5 +1,5 @@
-/* events
- * Copyright (c) 2016 ARM Limited
+/*
+ * Copyright (c) 2016-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,20 +21,25 @@
 #include "platform/mbed_assert.h"
 
 namespace events {
-/** \addtogroup events */
+/** \ingroup events */
+/** \addtogroup events-public-api Public API */
+/** @{*/
 
 /** Event
  *
  *  Representation of an event for fine-grain dispatch control
- * @ingroup events
  */
 template <typename F>
 class Event;
 
+/**
+ * \defgroup events_Event Event<void()> class
+ * @{
+ */
+
 /** Event
  *
  *  Representation of an event for fine-grain dispatch control
- * @ingroup events
  */
 template <>
 class Event<void()> {
@@ -483,10 +488,16 @@ class Event<void()> {
     }
 };
 
+/** @}*/
+
+/**
+ * \defgroup events_EventA0 Event<void(A0)> class
+ * @{
+ */
+
 /** Event
  *
  *  Representation of an event for fine-grain dispatch control
- * @ingroup events
  */
 template <typename A0>
 class Event<void(A0)> {
@@ -939,10 +950,16 @@ class Event<void(A0)> {
     }
 };
 
+/** @}*/
+
+/**
+ * \defgroup events_EventA0A1 Event<void(A0, A1)> class
+ * @{
+ */
+
 /** Event
  *
  *  Representation of an event for fine-grain dispatch control
- * @ingroup events
  */
 template <typename A0, typename A1>
 class Event<void(A0, A1)> {
@@ -1395,10 +1412,16 @@ class Event<void(A0, A1)> {
     }
 };
 
+/** @}*/
+
+/**
+ * \defgroup events_EventA0A1A2 Event<void(A0, A1, A2)> class
+ * @{
+ */
+
 /** 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)> {
@@ -1851,10 +1874,16 @@ class Event<void(A0, A1, A2)> {
     }
 };
 
+/** @}*/
+
+/**
+ * \defgroup events_EventA0A1A2A3 Event<void(A0, A1, A2, A3)> class
+ * @{
+ */
+
 /** 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)> {
@@ -2306,12 +2335,20 @@ class Event<void(A0, A1, A2, A3)> {
     {
         new (this) Event(q, mbed::callback(obj, method), b0, b1, b2, b3, b4);
     }
+#endif // DOXYGEN_ONLY
 };
 
+/** @}*/
+
+
+/**
+ * \defgroup events_EventA0A1A2A3A4 Event<void(A0, A1, A2, A3, A4)> class
+ * @{
+ */
+
 /** 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)> {
@@ -2764,12 +2801,11 @@ class Event<void(A0, A1, A2, A3, A4)> {
     }
 };
 
-
-/** \addtogroup events */
-/** @{ */
+/** @}*/
 
 // Convenience functions declared here to avoid cyclic
 // dependency between Event and EventQueue
+#if !defined(DOXYGEN_ONLY)
 template <typename R>
 Event<void()> EventQueue::event(R(*func)())
 {
@@ -4065,9 +4101,9 @@ Event<void(A0, A1, A2, A3, A4)> EventQueue::event(mbed::Callback<R(B0, B1, B2, B
 {
     return Event<void(A0, A1, A2, A3, A4)>(this, cb, c0, c1, c2, c3, c4);
 }
-#endif
+#endif // DOXYGEN_ONLY
+
+/** @}*/
 }
 
 #endif
-
-/** @}*/

events/EventQueue.h

@@ -1,5 +1,5 @@
-/* events
- * Copyright (c) 2016 ARM Limited
+/*
+ * Copyright (c) 2016-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,14 +18,16 @@
 #ifndef EVENT_QUEUE_H
 #define EVENT_QUEUE_H
 
-#include "equeue/equeue.h"
+#include "events/internal/equeue.h"
 #include "platform/Callback.h"
 #include "platform/NonCopyable.h"
 #include <cstddef>
 #include <new>
 
 namespace events {
-/** \addtogroup events */
+/** \ingroup events */
+/** \addtogroup events-public-api */
+/** @{*/
 
 /** EVENTS_EVENT_SIZE
  *  Minimum size of an event
@@ -43,11 +45,14 @@ namespace events {
 template <typename F>
 class Event;
 
+/**
+ * \defgroup events_EventQueue EventQueue class
+ * @{
+ */
 
 /** EventQueue
  *
  *  Flexible event queue for dispatching events
- * @ingroup events
  */
 class EventQueue : private mbed::NonCopyable<EventQueue> {
 public:
@@ -3402,7 +3407,9 @@ class EventQueue : private mbed::NonCopyable<EventQueue> {
 #endif //!defined(DOXYGEN_ONLY)
 };
 
+/** @}*/
+/** @}*/
+
 }
 
 #endif
-

events/equeue/.mbedignore renamed to events/internal/.mbedignore

@@ -1,7 +1,7 @@
 /*
  * Flexible event queue for dispatching events
  *
- * Copyright (c) 2016 Christopher Haster
+ * Copyright (c) 2016-2019 Christopher Haster
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-#include "equeue/equeue.h"
+#include "events/internal/equeue.h"
 
 #include <stdlib.h>
 #include <stdint.h>

events/EventQueue.cpp renamed to events/internal/EventQueue.cpp

@@ -1,10 +1,8 @@
 
-/** \addtogroup events */
-/** @{*/
 /*
  * Flexible event queue for dispatching events
  *
- * Copyright (c) 2016 Christopher Haster
+ * Copyright (c) 2016-2019 Christopher Haster
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,11 +24,14 @@ extern "C" {
 #endif
 
 // Platform specific files
-#include "equeue/equeue_platform.h"
+#include "events/internal/equeue_platform.h"
 
 #include <stddef.h>
 #include <stdint.h>
 
+/** \ingroup events */
+/** \addtogroup events-internal-api Internal API */
+/** @{*/
 
 // The minimum size of an event
 // This size is guaranteed to fit events created by event_call
@@ -225,11 +226,10 @@ void equeue_background(equeue_t *queue,
 // platform-specific error code.
 int equeue_chain(equeue_t *queue, equeue_t *target);
 
+/** @}*/
 
 #ifdef __cplusplus
 }
 #endif
 
 #endif
-
-/** @}*/

events/equeue/Makefile renamed to events/internal/Makefile

@@ -2,7 +2,7 @@
  * Implementation for the mbed library
  * https://github.com/mbedmicro/mbed
  *
- * Copyright (c) 2016 Christopher Haster
+ * Copyright (c) 2016-2019 Christopher Haster
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-#include "equeue/equeue_platform.h"
+#include "events/internal/equeue_platform.h"
 
 #if defined(EQUEUE_PLATFORM_MBED)
 

events/equeue/README.md renamed to events/internal/README.md

@@ -1,10 +1,7 @@
-
-/** \addtogroup events */
-/** @{*/
 /*
  * System specific implementation
  *
- * Copyright (c) 2016 Christopher Haster
+ * Copyright (c) 2016-2019 Christopher Haster
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,6 +24,10 @@ extern "C" {
 
 #include <stdbool.h>
 
+/** \ingroup events */
+/** \addtogroup events-internal-api */
+/** @{*/
+
 // Currently supported platforms
 //
 // Uncomment to select a supported platform or reimplement this file
@@ -142,11 +143,10 @@ void equeue_sema_destroy(equeue_sema_t *sema);
 void equeue_sema_signal(equeue_sema_t *sema);
 bool equeue_sema_wait(equeue_sema_t *sema, int ms);
 
+/** @}*/
 
 #ifdef __cplusplus
 }
 #endif
 
 #endif
-
-/** @}*/

events/equeue/equeue.c renamed to events/internal/equeue.c

@@ -1,7 +1,7 @@
 /*
  * Implementation for Posix compliant platforms
  *
- * Copyright (c) 2016 Christopher Haster
+ * Copyright (c) 2016-2019 Christopher Haster
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-#include "equeue/equeue_platform.h"
+#include "events/internal/equeue_platform.h"
 
 #if defined(EQUEUE_PLATFORM_POSIX)
 

events/equeue/equeue.h renamed to events/internal/equeue.h

@@ -1,8 +1,6 @@
-
 /** \addtogroup events */
 /** @{*/
-/* events
- * Copyright (c) 2016 ARM Limited
+/* Copyright (c) 2016-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,10 +18,6 @@
 #ifndef MBED_EVENTS_H
 #define MBED_EVENTS_H
 
-
-#include "equeue/equeue.h"
-
-
 #ifdef __cplusplus
 
 #include "events/EventQueue.h"

events/equeue/equeue_mbed.cpp renamed to events/internal/equeue_mbed.cpp

@@ -1,8 +1,5 @@
-
-/** \addtogroup events */
-/** @{*/
-/* events
- * Copyright (c) 2017 ARM Limited
+/*
+ * Copyright (c) 2016-2019 ARM Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +19,9 @@
 #include "events/EventQueue.h"
 
 namespace mbed {
+/** \ingroup events */
+/** \addtogroup events-public-api */
+/** @{*/
 
 /**
  * Return a pointer to an EventQueue, on which normal tasks can be queued.
@@ -85,8 +85,8 @@ events::EventQueue *mbed_highprio_event_queue();
 
 #endif // MBED_CONF_RTOS_PRESENT
 
-};
+/** @}*/
 
-#endif
+}
 
-/** @}*/
+#endif