Skip to content

Commit 9212bbe

Browse files
authored
doc: mention 0 is forever for NimBLESCan::start
Document that setting `duration` to zero means to scan forever.
1 parent f68bb5f commit 9212bbe

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/NimBLEScan.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ bool NimBLEScan::isScanning() {
285285

286286
/**
287287
* @brief Start scanning.
288-
* @param [in] duration The duration in milliseconds for which to scan.
288+
* @param [in] duration The duration in milliseconds for which to scan. 0 == scan forever.
289289
* @param [in] is_continue Set to true to save previous scan results, false to clear them.
290290
* @return True if scan started or false if there was an error.
291291
*/

0 commit comments

Comments
 (0)