From a7ff1beacd11297ce6cc31edef3f7c3984e76a39 Mon Sep 17 00:00:00 2001 From: Tristan Willy Date: Thu, 31 Oct 2024 16:09:05 -0700 Subject: [PATCH] doc: mention 0 is forever for NimBLESCan::start Document that setting `duration` to zero means to scan forever. --- src/NimBLEScan.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/NimBLEScan.cpp b/src/NimBLEScan.cpp index 1590b7c..2e449c6 100644 --- a/src/NimBLEScan.cpp +++ b/src/NimBLEScan.cpp @@ -285,7 +285,7 @@ bool NimBLEScan::isScanning() { /** * @brief Start scanning. - * @param [in] duration The duration in milliseconds for which to scan. + * @param [in] duration The duration in milliseconds for which to scan. 0 == scan forever. * @param [in] is_continue Set to true to save previous scan results, false to clear them. * @return True if scan started or false if there was an error. */