aboutsummaryrefslogtreecommitdiffstats
path: root/api/direct_bt/BTGattService.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'api/direct_bt/BTGattService.hpp')
-rw-r--r--api/direct_bt/BTGattService.hpp12
1 files changed, 12 insertions, 0 deletions
diff --git a/api/direct_bt/BTGattService.hpp b/api/direct_bt/BTGattService.hpp
index f4e6006b..f38b0328 100644
--- a/api/direct_bt/BTGattService.hpp
+++ b/api/direct_bt/BTGattService.hpp
@@ -62,9 +62,19 @@ namespace direct_bt {
class BTDevice; // forward
typedef std::shared_ptr<BTDevice> BTDeviceRef;
+ /** \addtogroup DBTUserClientAPI
+ *
+ * @{
+ */
+
/**
* Representing a Gatt Service object from the ::GATTRole::Client perspective.
*
+ * A list of shared BTGattService instances can be retrieved from BTDevice
+ * after successful connection and optional pairing via BTDevice::getGattServices().
+ *
+ * See [Direct-BT Overview](namespacedirect__bt.html#details).
+ *
* BT Core Spec v5.2: Vol 3, Part G GATT: 3.1 Service Definition
*
* Includes a complete [Primary] Service Declaration
@@ -148,6 +158,8 @@ namespace direct_bt {
inline bool operator!=(const BTGattService& lhs, const BTGattService& rhs) noexcept
{ return !(lhs == rhs); }
+ /**@}*/
+
} // namespace direct_bt
#endif /* BT_GATT_SERVICE_HPP_ */