Skip to content

Commit 65bb642

Browse files
committed
BLE: Deprecate GapEvent
This class and its components are not used by BLE API and never been used in the last two years. This patch deprecate all the components in GapEvent.h and exclude its definitions from the documentation process.
1 parent 20d93bf commit 65bb642

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

features/FEATURE_BLE/ble/GapEvents.h

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,37 @@
1414
* limitations under the License.
1515
*/
1616

17-
#ifndef __GAP_EVENTS_H__
18-
#define __GAP_EVENTS_H__
17+
#ifndef MBED_GAP_EVENTS_H__
18+
#define MBED_GAP_EVENTS_H__
1919

2020
#include "blecommon.h"
2121

22-
/**************************************************************************/
22+
/// @cond 0
23+
2324
/*!
2425
\brief
2526
The base class used to abstract away the callback events that can be
2627
triggered with the GAP.
28+
29+
@deprecated Do not use; it is not used by BLE API.
2730
*/
28-
/**************************************************************************/
2931
class GapEvents
3032
{
3133
public:
32-
/******************************************************************/
3334
/*!
3435
\brief
3536
Identifies GAP events generated by the radio HW when an event
3637
callback occurs.
38+
39+
@deprecated Do not use; it is not used by BLE API.
3740
*/
38-
/******************************************************************/
3941
typedef enum gapEvent_e {
4042
GAP_EVENT_TIMEOUT = 1, /**< Advertising timed out before a connection could be established. */
4143
GAP_EVENT_CONNECTED = 2, /**< A connection was established with a central device. */
4244
GAP_EVENT_DISCONNECTED = 3 /**< A connection was closed or lost with a central device. */
4345
} gapEvent_t;
4446
};
4547

46-
#endif // ifndef __GAP_EVENTS_H__
48+
/// @endcond
49+
50+
#endif // ifndef MBED_GAP_EVENTS_H__

0 commit comments

Comments
 (0)