Merge pull request #5410 from pan-/deprecate-gap-events

BLE: Deprecate GapEvent

Author: theotherjimmy

features/FEATURE_BLE/ble/GapEvents.h

@@ -14,33 +14,37 @@
  * limitations under the License.
  */
 
-#ifndef __GAP_EVENTS_H__
-#define __GAP_EVENTS_H__
+#ifndef MBED_GAP_EVENTS_H__
+#define MBED_GAP_EVENTS_H__
 
 #include "blecommon.h"
 
-/**************************************************************************/
+/// @cond 0
+
 /*!
     \brief
     The base class used to abstract away the callback events that can be
     triggered with the GAP.
+
+    @deprecated Do not use; it is not used by BLE API.
 */
-/**************************************************************************/
 class GapEvents
 {
 public:
-    /******************************************************************/
     /*!
         \brief
         Identifies GAP events generated by the radio HW when an event
         callback occurs.
+
+        @deprecated Do not use; it is not used by BLE API.
     */
-    /******************************************************************/
     typedef enum gapEvent_e {
         GAP_EVENT_TIMEOUT      = 1, /**< Advertising timed out before a connection could be established. */
         GAP_EVENT_CONNECTED    = 2, /**< A connection was established with a central device. */
         GAP_EVENT_DISCONNECTED = 3  /**< A connection was closed or lost with a central device. */
     } gapEvent_t;
 };
 
-#endif // ifndef __GAP_EVENTS_H__
+/// @endcond
+
+#endif // ifndef MBED_GAP_EVENTS_H__