WifiScanner: Enhance doc for setScanningEnabled API

The existing WifiScanner.setScanningEnabled() API is invoked by
ActiveModeWarden after any client iface state changes. Documenting this
behavior explicitly (i.e enable needs to be invoked multiple time if
there are multiple STA's brought up).

Bug: 140111024
Test: None
Change-Id: Ie377a9b57119cb7389df60294fc2111ec654fd38
This commit is contained in:
Roshan Pius
2019-09-18 14:49:18 -07:00
parent 05a91477e5
commit 49cc6e3af7

View File

@@ -750,7 +750,10 @@ public class WifiScanner {
/**
* Enable/Disable wifi scanning.
*
* Note: WifiService calls this after any client interface mode changes (i.e. a new interface
* set up or an existing interface torn down)
* If there are >= 1 active client interface, invoke setScanningEnabled(true)
* If there are 0 active client interface, invoke setScanningEnabled(false)
* {@hide}
*/
@RequiresPermission(Manifest.permission.NETWORK_STACK)