wifi: WifiConfiguration: update documentation for isHomeProviderNetwork

Address API Councils comment on documentation for isHomeProviderNetwork
field.  Specifically, the expected value for this field for non-Passpoint
network configuration.

Bug: 35855359
Test: make -j32
Change-Id: Ie6cdcc39c5156dccc14ed144e58a6d2f201aef17
This commit is contained in:
Peter Qiu
2017-03-01 09:49:51 -08:00
parent f8dbd216c8
commit f7303ba18e

View File

@@ -376,7 +376,9 @@ public class WifiConfiguration implements Parcelable {
/**
* Flag indicating if this network is provided by a home Passpoint provider or a roaming
* Passpoint provider.
* Passpoint provider. This flag will be {@code true} if this network is provided by
* a home Passpoint provider and {@code false} if is provided by a roaming Passpoint provider
* or is a non-Passpoint network.
*/
public boolean isHomeProviderNetwork;