Bluetooth: doc: Use proper grouping for APIs
Change-Id: Ifb3483d300409d280ca12aef5f49a983eff92496 Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
This commit is contained in:
parent
083a7ad0df
commit
37c0944d05
8 changed files with 87 additions and 0 deletions
|
@ -20,6 +20,12 @@
|
|||
#ifndef __BT_BLUETOOTH_H
|
||||
#define __BT_BLUETOOTH_H
|
||||
|
||||
/**
|
||||
* @brief Bluetooth APIs
|
||||
* @defgroup bluetooth Bluetooth APIs
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
|
@ -407,4 +413,8 @@ int bt_br_set_connectable(bool enable);
|
|||
}
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#endif /* __BT_BLUETOOTH_H */
|
||||
|
|
|
@ -21,6 +21,13 @@
|
|||
#ifndef __BT_BUF_H
|
||||
#define __BT_BUF_H
|
||||
|
||||
/**
|
||||
* @brief Data buffers
|
||||
* @defgroup bt_buf Data buffers
|
||||
* @ingroup bluetooth
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include <stdint.h>
|
||||
#include <net/buf.h>
|
||||
#include <bluetooth/hci.h>
|
||||
|
@ -68,4 +75,8 @@ static inline enum bt_buf_type bt_buf_get_type(struct net_buf *buf)
|
|||
return *(uint8_t *)net_buf_user_data(buf);
|
||||
}
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#endif /* __BT_BUF_H */
|
||||
|
|
|
@ -20,6 +20,13 @@
|
|||
#ifndef __BT_CONN_H
|
||||
#define __BT_CONN_H
|
||||
|
||||
/**
|
||||
* @brief Connection management
|
||||
* @defgroup bt_conn Connection management
|
||||
* @ingroup bluetooth
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
@ -430,4 +437,8 @@ struct bt_conn *bt_conn_create_br(const bt_addr_t *peer,
|
|||
}
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#endif /* __BT_CONN_H */
|
||||
|
|
|
@ -20,6 +20,13 @@
|
|||
#ifndef __BT_DRIVER_H
|
||||
#define __BT_DRIVER_H
|
||||
|
||||
/**
|
||||
* @brief HCI drivers
|
||||
* @defgroup bt_driver HCI drivers
|
||||
* @ingroup bluetooth
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include <net/buf.h>
|
||||
#include <bluetooth/buf.h>
|
||||
|
||||
|
@ -88,4 +95,8 @@ void bt_driver_unregister(struct bt_driver *drv);
|
|||
}
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#endif /* __BT_DRIVER_H */
|
||||
|
|
|
@ -20,6 +20,13 @@
|
|||
#ifndef __BT_GATT_H
|
||||
#define __BT_GATT_H
|
||||
|
||||
/**
|
||||
* @brief Generic Attribute Profile (GATT)
|
||||
* @defgroup bt_gatt Generic Attribute Profile (GATT)
|
||||
* @ingroup bluetooth
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
@ -1018,4 +1025,8 @@ void bt_gatt_cancel(struct bt_conn *conn);
|
|||
}
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#endif /* __BT_GATT_H */
|
||||
|
|
|
@ -34,6 +34,13 @@
|
|||
#ifndef __BT_L2CAP_H
|
||||
#define __BT_L2CAP_H
|
||||
|
||||
/**
|
||||
* @brief L2CAP
|
||||
* @defgroup bt_l2cap L2CAP
|
||||
* @ingroup bluetooth
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
@ -220,4 +227,8 @@ int bt_l2cap_chan_send(struct bt_l2cap_chan *chan, struct net_buf *buf);
|
|||
}
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#endif /* __BT_L2CAP_H */
|
||||
|
|
|
@ -20,6 +20,13 @@
|
|||
#ifndef __BT_STORAGE_H
|
||||
#define __BT_STORAGE_H
|
||||
|
||||
/**
|
||||
* @brief Persistent Storage
|
||||
* @defgroup bt_storage Persistent Storage
|
||||
* @ingroup bluetooth
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include <sys/types.h>
|
||||
|
||||
#include <bluetooth/bluetooth.h>
|
||||
|
@ -88,4 +95,8 @@ int bt_storage_clear(bt_addr_le_t *addr);
|
|||
}
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#endif /* __BT_STORAGE_H */
|
||||
|
|
|
@ -20,6 +20,13 @@
|
|||
#ifndef __BT_UUID_H
|
||||
#define __BT_UUID_H
|
||||
|
||||
/**
|
||||
* @brief UUIDs
|
||||
* @defgroup bt_uuid UUIDs
|
||||
* @ingroup bluetooth
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include <misc/util.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
|
@ -438,4 +445,8 @@ static inline const char *bt_uuid_str(const struct bt_uuid *uuid)
|
|||
}
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#endif /* __BT_UUID_H */
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue