doc: mention 0 is forever for NimBLESCan::start

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

View file

@ -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.
*/