espressif/esp-nimble
1
0
Fork 0
mirror of https://github.com/espressif/esp-nimble.git synced 2026-08-07 02:27:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

host/uuid: add doxygen comments for the header file

Browse Source 
Adds missing macros and structures documentation.
This commit is contained in:
Wojciech Pietraszewski
2023-07-18 09:33:57 +02:00
committed by Szymon Janc
parent 98d972d220
commit 37697bbc74
1 changed files with 85 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
nimble/host/include/host/ble_uuid.h
+85
View File
@@ -56,30 +56,55 @@ typedef struct {
/** 16-bit UUID */
typedef struct {
/** Generic UUID structure */
ble_uuid_t u;
/** 16-bit UUID value */
uint16_t value;
} ble_uuid16_t;
/** 32-bit UUID */
typedef struct {
/** Generic UUID structure */
ble_uuid_t u;
/** 32-bit UUID value */
uint32_t value;
} ble_uuid32_t;
/** 128-bit UUID */
typedef struct {
/** Generic UUID structure */
ble_uuid_t u;
/** 128-bit UUID value */
uint8_t value[16];
} ble_uuid128_t;
/** Universal UUID type, to be used for any-UUID static allocation */
typedef union {
/** Generic UUID structure */
ble_uuid_t u;
/** 16-bit UUID structure */
ble_uuid16_t u16;
/** 32-bit UUID structure */
ble_uuid32_t u32;
/** 128-bit UUID structure */
ble_uuid128_t u128;
} ble_uuid_any_t;
/**
* @brief Macro for initializing a 16-bit UUID.
*
* This macro initializes a 16-bit UUID with the provided value.
*
* @param uuid16 The value of the 16-bit UUID.
*
* @return The initialized 16-bit UUID structure.
*/
#define BLE_UUID16_INIT(uuid16) \
{ \
.u = { \
@@ -88,6 +113,15 @@ typedef union {
.value = (uuid16), \
}
/**
* @brief Macro for initializing a 32-bit UUID.
*
* This macro initializes a 32-bit UUID with the provided value.
*
* @param uuid32 The value of the 32-bit UUID.
*
* @return The initialized 32-bit UUID structure.
*/
#define BLE_UUID32_INIT(uuid32) \
{ \
.u = { \
@@ -96,6 +130,15 @@ typedef union {
.value = (uuid32), \
}
/**
* @brief Macro for initializing a 128-bit UUID.
*
* This macro initializes a 128-bit UUID with the provided value.
*
* @param uuid128 The value of the 128-bit UUID.
*
* @return The initialized 128-bit UUID structure.
*/
#define BLE_UUID128_INIT(uuid128 ...) \
{ \
.u = { \
@@ -104,21 +147,63 @@ typedef union {
.value = { uuid128 }, \
}
/**
* @brief Macro for declaring a pointer to a 16-bit UUID structure initialized with a specific 16-bit UUID value.
*
* @param uuid16 The 16-bit UUID value to initialize the structure with.
*
* @return Pointer to a `ble_uuid_t` structure.
*/
#define BLE_UUID16_DECLARE(uuid16) \
((ble_uuid_t *) (&(ble_uuid16_t) BLE_UUID16_INIT(uuid16)))
/**
* @brief Macro for declaring a pointer to a 32-bit UUID structure initialized with a specific 32-bit UUID value.
*
* @param uuid32 The 32-bit UUID value to initialize the structure with.
*
* @return Pointer to a `ble_uuid_t` structure.
*/
#define BLE_UUID32_DECLARE(uuid32) \
((ble_uuid_t *) (&(ble_uuid32_t) BLE_UUID32_INIT(uuid32)))
/**
* @brief Macro for declaring a pointer to a 128-bit UUID structure initialized with specific 128-bit UUID values.
*
* @param uuid128 The 128-bit UUID value to initialize the structure with.
*
* @return Pointer to a `ble_uuid_t` structure.
*/
#define BLE_UUID128_DECLARE(uuid128...) \
((ble_uuid_t *) (&(ble_uuid128_t) BLE_UUID128_INIT(uuid128)))
/**
* @brief Macro for casting a pointer to a `ble_uuid_t` structure to a pointer to 16-bit UUID structure.
*
* @param u Pointer to a `ble_uuid_t` structure.
*
* @return Pointer to a `ble_uuid16_t` structure.
*/
#define BLE_UUID16(u) \
((ble_uuid16_t *) (u))
/**
* @brief Macro for casting a pointer to a `ble_uuid_t` structure to a pointer to 32-bit UUID structure.
*
* @param u Pointer to a `ble_uuid_t` structure.
*
* @return Pointer to a `ble_uuid32_t` structure.
*/
#define BLE_UUID32(u) \
((ble_uuid32_t *) (u))
/**
* @brief Macro for casting a pointer to a `ble_uuid_t` structure to a pointer to 128-bit UUID structure.
*
* @param u Pointer to a `ble_uuid_t` structure.
*
* @return Pointer to a `ble_uuid128_t` structure.
*/
#define BLE_UUID128(u) \
((ble_uuid128_t *) (u))