From 51a5d78c15a17f2b6fcab7de2366048471c381ab Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Thu, 28 May 2020 19:10:53 +0200
Subject: DBTDevice.hpp: More API doc

---
 api/direct_bt/DBTDevice.hpp | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/api/direct_bt/DBTDevice.hpp b/api/direct_bt/DBTDevice.hpp
index ee9f2569..4c86e583 100644
--- a/api/direct_bt/DBTDevice.hpp
+++ b/api/direct_bt/DBTDevice.hpp
@@ -33,7 +33,6 @@
 #include <vector>
 
 #include <mutex>
-#include <atomic>
 
 #include "DBTTypes.hpp"
 
@@ -119,11 +118,21 @@ namespace direct_bt {
             bool isLEAddressType() const { return BDADDR_LE_PUBLIC == addressType || BDADDR_LE_RANDOM == addressType; }
             bool isBREDRAddressType() const { return BDADDR_BREDR == addressType; }
 
+            /** Return RSSI of device as recognized at discovery and connect. */
             int8_t getRSSI() const { return rssi; }
+
+            /** Return Tx Power of device as recognized at discovery and connect. */
             int8_t getTxPower() const { return tx_power; }
+
+            /** Return AppearanceCat of device as recognized at discovery, connect and GATT discovery. */
             AppearanceCat getAppearance() const { return appearance; }
+
             std::string const getName() const;
+
+            /** Return shared ManufactureSpecificData as recognized at discovery, pre GATT discovery. */
             std::shared_ptr<ManufactureSpecificData> const getManufactureSpecificData() const;
+
+            /** Return a list of services as recognized at discovery, pre GATT discovery. */
             std::vector<std::shared_ptr<uuid_t>> getServices() const;
 
             /** Returns index >= 0 if found, otherwise -1 */
-- 
cgit v1.2.3