From efd9938140595944dbdf7fa05e653e7cd61a7e7c Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Mon, 21 Sep 2020 02:30:22 +0200
Subject: Doxygen: C++ package and private extraction creates too verbose
 documentation, leave it out for now.

We may add a developer api doc later on.

Also mention HCIHandler correctly in DBTAdapter and DBTDevice, where it is being used.
---
 api/direct_bt/DBTAdapter.hpp |  6 ++++--
 api/direct_bt/DBTDevice.hpp  | 15 +++++++++++++++
 2 files changed, 19 insertions(+), 2 deletions(-)

(limited to 'api')

diff --git a/api/direct_bt/DBTAdapter.hpp b/api/direct_bt/DBTAdapter.hpp
index b8890061..c3580478 100644
--- a/api/direct_bt/DBTAdapter.hpp
+++ b/api/direct_bt/DBTAdapter.hpp
@@ -447,7 +447,8 @@ namespace direct_bt {
              * and usual discovery intervals etc.
              * </p>
              * <p>
-             * This adapter's DBTManager instance is used, i.e. the management channel.
+             * This adapter's HCIHandler instance is used to initiate scanning,
+             * see HCIHandler::le_set_scan_param() and HCIHandler::le_enable_scan().
              * </p>
              * <p>
              * Method will always clear previous discovered devices via removeDiscoveredDevices().
@@ -464,7 +465,8 @@ namespace direct_bt {
             /**
              * Closes the discovery session.
              * <p>
-             * This adapter's DBTManager instance is used, i.e. the management channel.
+             * This adapter's HCIHandler instance is used to stop scanning,
+             * see HCIHandler::le_enable_scan().
              * </p>
              * @return true if no error, otherwise false.
              */
diff --git a/api/direct_bt/DBTDevice.hpp b/api/direct_bt/DBTDevice.hpp
index af7b94f3..8aa374ac 100644
--- a/api/direct_bt/DBTDevice.hpp
+++ b/api/direct_bt/DBTDevice.hpp
@@ -230,6 +230,10 @@ namespace direct_bt {
              * <p>
              * Set window to the same value as the interval, enables continuous scanning.
              * </p>
+             * <p>
+             * The associated DBTAdapter's HCIHandler instance is used to connect,
+             * see HCIHandler::le_create_conn().
+             * </p>
              *
              * @param le_scan_interval in units of 0.625ms, default value 48 for 30ms, min value 4 for 2.5ms -> 0x4000 for 10.24s
              * @param le_scan_window in units of 0.625ms, default value 48 for 30ms,  min value 4 for 2.5ms -> 0x4000 for 10.24s. Shall be <= le_scan_interval
@@ -261,6 +265,10 @@ namespace direct_bt {
              * <p>
              * The device is tracked by the managing adapter.
              * </p>
+             * <p>
+             * The associated DBTAdapter's HCIHandler instance is used to connect,
+             * see HCIHandler::create_conn().
+             * </p>
              * @return HCIStatusCode::SUCCESS if the command has been accepted, otherwise HCIStatusCode may disclose reason for rejection.
              */
             HCIStatusCode connectBREDR(const uint16_t pkt_type=HCI_DM1 | HCI_DM3 | HCI_DM5 | HCI_DH1 | HCI_DH3 | HCI_DH5,
@@ -284,6 +292,9 @@ namespace direct_bt {
              * <p>
              * The device is tracked by the managing adapter.
              * </p>
+             * <p>
+             * See connectLE() and connectBREDR() for more details.
+             * </p>
              * @return HCIStatusCode::SUCCESS if the command has been accepted, otherwise HCIStatusCode may disclose reason for rejection.
              */
             HCIStatusCode connectDefault();
@@ -314,6 +325,10 @@ namespace direct_bt {
              * but never issue remove() after disconnect(). Doing so would eventually delete the device being already
              * in use by another thread due to discovery post disconnect!
              * </p>
+             * <p>
+             * The associated DBTAdapter's HCIHandler instance is used to disconnect,
+             * see HCIHandler::disconnect().
+             * </p>
              * @return HCIStatusCode::SUCCESS if the command has been accepted, otherwise HCIStatusCode may disclose reason for rejection.
              */
             HCIStatusCode disconnect(const HCIStatusCode reason=HCIStatusCode::REMOTE_USER_TERMINATED_CONNECTION ) {
-- 
cgit v1.2.3