From f4d35c3a26eaaf21f8dba55c92a5788d55541521 Mon Sep 17 00:00:00 2001
From: Nikita Pavlov <12559805+niksiboxi@users.noreply.github.com>
Date: Tue, 9 Mar 2021 11:53:40 +0200
Subject: [PATCH] Fix documentation for updated and new modules (#26)

---
 src/app_ble.h | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/src/app_ble.h b/src/app_ble.h
index 800bec5..a6e063c 100644
--- a/src/app_ble.h
+++ b/src/app_ble.h
@@ -79,8 +79,10 @@ rd_status_t app_ble_modulation_enable (const ri_radio_modulation_t modulation,
 /**
  * @brief Start a scan sequence.
  *
- * Runs through enabled modulations and channels, automatically starting
- * on next after one has finished. Calls given scan callback on data.
+ * Checks if any PHY is enabled. Runs through enabled modulations and channels,
+ * automatically starting on next after one has finished. Calls given scan
+ * callback on data. If all PHYs are disabled, calls app_ble_scan_stop() to
+ * stop scanning process until any PHY is reactivated.
  *
  * @retval RD_SUCCESS on success.
  *
@@ -97,6 +99,14 @@ rd_status_t app_ble_scan_start (void);
  */
 bool app_ble_manufacturer_filter_enabled (void);
 
+/**
+ * @brief Stop a scan sequence.
+ *
+ * Aborts the scanning process.
+ *
+ * @retval RD_SUCCESS on success.
+ * @retval RD_ERROR_INVALID_STATE if scan is not initialized.
+ */
 rd_status_t app_ble_scan_stop (void);
 
 #ifdef CEEDLING