feedc0de/esp-nimble-cpp
1
0
Fork 0
forked from h2zero/esp-nimble-cpp
Code Pull Requests Activity

doc: mention 0 is forever for NimBLESCan::start

Browse Source 
Document that setting `duration` to zero means to scan forever.
This commit is contained in:
Tristan Willy
2024-10-31 16:09:05 -07:00
committed by h2zero
parent ed2c59d5de
commit a7ff1beacd
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/NimBLEScan.cpp
View File

@ -285,7 +285,7 @@ bool NimBLEScan::isScanning() {
/** /**
* @brief Start scanning. * @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. * @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. * @return True if scan started or false if there was an error.
*/ */