From 37c0944d05e642ddf37387ce2b245d108b9106e3 Mon Sep 17 00:00:00 2001 From: Johan Hedberg Date: Mon, 16 May 2016 19:54:24 +0300 Subject: [PATCH] Bluetooth: doc: Use proper grouping for APIs Change-Id: Ifb3483d300409d280ca12aef5f49a983eff92496 Signed-off-by: Johan Hedberg --- include/bluetooth/bluetooth.h | 10 ++++++++++ include/bluetooth/buf.h | 11 +++++++++++ include/bluetooth/conn.h | 11 +++++++++++ include/bluetooth/driver.h | 11 +++++++++++ include/bluetooth/gatt.h | 11 +++++++++++ include/bluetooth/l2cap.h | 11 +++++++++++ include/bluetooth/storage.h | 11 +++++++++++ include/bluetooth/uuid.h | 11 +++++++++++ 8 files changed, 87 insertions(+) diff --git a/include/bluetooth/bluetooth.h b/include/bluetooth/bluetooth.h index fa4f07689a8..54be7ca19ce 100644 --- a/include/bluetooth/bluetooth.h +++ b/include/bluetooth/bluetooth.h @@ -20,6 +20,12 @@ #ifndef __BT_BLUETOOTH_H #define __BT_BLUETOOTH_H +/** + * @brief Bluetooth APIs + * @defgroup bluetooth Bluetooth APIs + * @{ + */ + #include #include #include @@ -407,4 +413,8 @@ int bt_br_set_connectable(bool enable); } #endif +/** + * @} + */ + #endif /* __BT_BLUETOOTH_H */ diff --git a/include/bluetooth/buf.h b/include/bluetooth/buf.h index 2cd9aa7c99a..c2b39d17b13 100644 --- a/include/bluetooth/buf.h +++ b/include/bluetooth/buf.h @@ -21,6 +21,13 @@ #ifndef __BT_BUF_H #define __BT_BUF_H +/** + * @brief Data buffers + * @defgroup bt_buf Data buffers + * @ingroup bluetooth + * @{ + */ + #include #include #include @@ -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 */ diff --git a/include/bluetooth/conn.h b/include/bluetooth/conn.h index 100da16c982..a4cf9a9d3cb 100644 --- a/include/bluetooth/conn.h +++ b/include/bluetooth/conn.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 */ diff --git a/include/bluetooth/driver.h b/include/bluetooth/driver.h index 4ea2a0b7c07..94e9ff68313 100644 --- a/include/bluetooth/driver.h +++ b/include/bluetooth/driver.h @@ -20,6 +20,13 @@ #ifndef __BT_DRIVER_H #define __BT_DRIVER_H +/** + * @brief HCI drivers + * @defgroup bt_driver HCI drivers + * @ingroup bluetooth + * @{ + */ + #include #include @@ -88,4 +95,8 @@ void bt_driver_unregister(struct bt_driver *drv); } #endif +/** + * @} + */ + #endif /* __BT_DRIVER_H */ diff --git a/include/bluetooth/gatt.h b/include/bluetooth/gatt.h index 848aa0baa13..4c517db22d0 100644 --- a/include/bluetooth/gatt.h +++ b/include/bluetooth/gatt.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 */ diff --git a/include/bluetooth/l2cap.h b/include/bluetooth/l2cap.h index c4f429f89ec..05cf7452dd3 100644 --- a/include/bluetooth/l2cap.h +++ b/include/bluetooth/l2cap.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 */ diff --git a/include/bluetooth/storage.h b/include/bluetooth/storage.h index 189383b4ae2..851cbdeb104 100644 --- a/include/bluetooth/storage.h +++ b/include/bluetooth/storage.h @@ -20,6 +20,13 @@ #ifndef __BT_STORAGE_H #define __BT_STORAGE_H +/** + * @brief Persistent Storage + * @defgroup bt_storage Persistent Storage + * @ingroup bluetooth + * @{ + */ + #include #include @@ -88,4 +95,8 @@ int bt_storage_clear(bt_addr_le_t *addr); } #endif +/** + * @} + */ + #endif /* __BT_STORAGE_H */ diff --git a/include/bluetooth/uuid.h b/include/bluetooth/uuid.h index d3443d92d84..30a4d19e329 100644 --- a/include/bluetooth/uuid.h +++ b/include/bluetooth/uuid.h @@ -20,6 +20,13 @@ #ifndef __BT_UUID_H #define __BT_UUID_H +/** + * @brief UUIDs + * @defgroup bt_uuid UUIDs + * @ingroup bluetooth + * @{ + */ + #include #ifdef __cplusplus @@ -438,4 +445,8 @@ static inline const char *bt_uuid_str(const struct bt_uuid *uuid) } #endif +/** + * @} + */ + #endif /* __BT_UUID_H */