Skip to content

Commit 67b47ca

Browse files
committed
BLE: Group GattServer documented elements
1 parent 1c2685c commit 67b47ca

File tree

5 files changed

+76
-0
lines changed

5 files changed

+76
-0
lines changed

features/FEATURE_BLE/ble/GattAttribute.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@
2020
#include "UUID.h"
2121
#include "BLETypes.h"
2222

23+
/**
24+
* @addtogroup ble
25+
* @{
26+
* @addtogroup gatt
27+
* @{
28+
* @addtogroup server
29+
* @{
30+
*/
31+
2332
/**
2433
* Instances of this class encapsulate the data that belongs to a Bluetooth Low
2534
* Energy attribute.
@@ -172,4 +181,10 @@ class GattAttribute {
172181
GattAttribute& operator=(const GattAttribute &);
173182
};
174183

184+
/**
185+
* @}
186+
* @}
187+
* @}
188+
*/
189+
175190
#endif /* ifndef __GATT_ATTRIBUTE_H__ */

features/FEATURE_BLE/ble/GattCharacteristic.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@
2323
#include "GattCallbackParamTypes.h"
2424
#include "FunctionPointerWithContext.h"
2525

26+
/**
27+
* @addtogroup ble
28+
* @{
29+
* @addtogroup gatt
30+
* @{
31+
* @addtogroup server
32+
* @{
33+
*/
34+
2635
class GattCharacteristic {
2736
public:
2837
enum {
@@ -860,4 +869,10 @@ class ReadWriteArrayGattCharacteristic : public GattCharacteristic {
860869
}
861870
};
862871

872+
/**
873+
* @}
874+
* @}
875+
* @}
876+
*/
877+
863878
#endif /* ifndef __GATT_CHARACTERISTIC_H__ */

features/FEATURE_BLE/ble/GattServer.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@
2424
#include "GattCallbackParamTypes.h"
2525
#include "CallChainOfFunctionPointersWithContext.h"
2626

27+
/**
28+
* @addtogroup ble
29+
* @{
30+
* @addtogroup gatt
31+
* @{
32+
* @addtogroup server
33+
* @{
34+
*/
35+
2736
class GattServer {
2837
public:
2938
/**
@@ -686,4 +695,10 @@ class GattServer {
686695
GattServer& operator=(const GattServer &);
687696
};
688697

698+
/**
699+
* @}
700+
* @}
701+
* @}
702+
*/
703+
689704
#endif /* ifndef __GATT_SERVER_H__ */

features/FEATURE_BLE/ble/GattServerEvents.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,15 @@
1717
#ifndef MBED_BLE_GATT_SERVER_EVENTS_H__
1818
#define MBED_BLE_GATT_SERVER_EVENTS_H__
1919

20+
/**
21+
* @addtogroup ble
22+
* @{
23+
* @addtogroup gatt
24+
* @{
25+
* @addtogroup server
26+
* @{
27+
*/
28+
2029
/**
2130
* Abstract events generated by a GattServer vendor port.
2231
*
@@ -68,4 +77,10 @@ class GattServerEvents
6877
} gattEvent_t;
6978
};
7079

80+
/**
81+
* @}
82+
* @}
83+
* @}
84+
*/
85+
7186
#endif /* ifndef MBED_BLE_GATT_SERVER_EVENTS_H__ */

features/FEATURE_BLE/ble/GattService.h

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@
2020
#include "UUID.h"
2121
#include "GattCharacteristic.h"
2222

23+
/**
24+
* @addtogroup ble
25+
* @{
26+
* @addtogroup gatt
27+
* @{
28+
* @addtogroup server
29+
* @{
30+
*/
31+
2332
class GattService {
2433
public:
2534
enum {
@@ -140,4 +149,11 @@ class GattService {
140149
uint16_t _handle;
141150
};
142151

152+
/**
153+
* @}
154+
* @}
155+
* @}
156+
*/
157+
158+
143159
#endif /* ifndef __GATT_SERVICE_H__ */

0 commit comments

Comments
 (0)