BLE: Group GattServer documented elements

pull/5392/head
Vincent Coubard 2017-10-27 11:44:34 -05:00
parent 1c2685c2ac
commit 67b47cad87
5 changed files with 76 additions and 0 deletions

View File

@ -20,6 +20,15 @@
#include "UUID.h"
#include "BLETypes.h"
/**
* @addtogroup ble
* @{
* @addtogroup gatt
* @{
* @addtogroup server
* @{
*/
/**
* Instances of this class encapsulate the data that belongs to a Bluetooth Low
* Energy attribute.
@ -172,4 +181,10 @@ private:
GattAttribute& operator=(const GattAttribute &);
};
/**
* @}
* @}
* @}
*/
#endif /* ifndef __GATT_ATTRIBUTE_H__ */

View File

@ -23,6 +23,15 @@
#include "GattCallbackParamTypes.h"
#include "FunctionPointerWithContext.h"
/**
* @addtogroup ble
* @{
* @addtogroup gatt
* @{
* @addtogroup server
* @{
*/
class GattCharacteristic {
public:
enum {
@ -860,4 +869,10 @@ public:
}
};
/**
* @}
* @}
* @}
*/
#endif /* ifndef __GATT_CHARACTERISTIC_H__ */

View File

@ -24,6 +24,15 @@
#include "GattCallbackParamTypes.h"
#include "CallChainOfFunctionPointersWithContext.h"
/**
* @addtogroup ble
* @{
* @addtogroup gatt
* @{
* @addtogroup server
* @{
*/
class GattServer {
public:
/**
@ -686,4 +695,10 @@ private:
GattServer& operator=(const GattServer &);
};
/**
* @}
* @}
* @}
*/
#endif /* ifndef __GATT_SERVER_H__ */

View File

@ -17,6 +17,15 @@
#ifndef MBED_BLE_GATT_SERVER_EVENTS_H__
#define MBED_BLE_GATT_SERVER_EVENTS_H__
/**
* @addtogroup ble
* @{
* @addtogroup gatt
* @{
* @addtogroup server
* @{
*/
/**
* Abstract events generated by a GattServer vendor port.
*
@ -68,4 +77,10 @@ public:
} gattEvent_t;
};
/**
* @}
* @}
* @}
*/
#endif /* ifndef MBED_BLE_GATT_SERVER_EVENTS_H__ */

View File

@ -20,6 +20,15 @@
#include "UUID.h"
#include "GattCharacteristic.h"
/**
* @addtogroup ble
* @{
* @addtogroup gatt
* @{
* @addtogroup server
* @{
*/
class GattService {
public:
enum {
@ -140,4 +149,11 @@ private:
uint16_t _handle;
};
/**
* @}
* @}
* @}
*/
#endif /* ifndef __GATT_SERVICE_H__ */