Merge "wifi: fix incorrect java doc" into rvc-dev
This commit is contained in:
committed by
Android (Google) Code Review
commit
1933391c5b
@@ -102,7 +102,9 @@ public final class SoftApCapability implements Parcelable {
|
|||||||
/**
|
/**
|
||||||
* Returns true when all of the queried features are supported, otherwise false.
|
* Returns true when all of the queried features are supported, otherwise false.
|
||||||
*
|
*
|
||||||
* @param features One or combination of the features from {@link @HotspotFeatures}
|
* @param features One or combination of the following features:
|
||||||
|
* {@link #SOFTAP_FEATURE_ACS_OFFLOAD}, {@link #SOFTAP_FEATURE_CLIENT_FORCE_DISCONNECT} or
|
||||||
|
* {@link #SOFTAP_FEATURE_WPA3_SAE}.
|
||||||
*/
|
*/
|
||||||
public boolean areFeaturesSupported(@HotspotFeatures long features) {
|
public boolean areFeaturesSupported(@HotspotFeatures long features) {
|
||||||
return (mSupportedFeatures & features) == features;
|
return (mSupportedFeatures & features) == features;
|
||||||
@@ -122,7 +124,9 @@ public final class SoftApCapability implements Parcelable {
|
|||||||
* Constructor with combination of the feature.
|
* Constructor with combination of the feature.
|
||||||
* Zero to no supported feature.
|
* Zero to no supported feature.
|
||||||
*
|
*
|
||||||
* @param features One or combination of the features from {@link @HotspotFeatures}.
|
* @param features One or combination of the following features:
|
||||||
|
* {@link #SOFTAP_FEATURE_ACS_OFFLOAD}, {@link #SOFTAP_FEATURE_CLIENT_FORCE_DISCONNECT} or
|
||||||
|
* {@link #SOFTAP_FEATURE_WPA3_SAE}.
|
||||||
* @hide
|
* @hide
|
||||||
*/
|
*/
|
||||||
public SoftApCapability(@HotspotFeatures long features) {
|
public SoftApCapability(@HotspotFeatures long features) {
|
||||||
|
|||||||
@@ -165,7 +165,8 @@ public final class SoftApConfiguration implements Parcelable {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The operating band of the AP.
|
* The operating band of the AP.
|
||||||
* One of the band types from {@link @BandType}.
|
* One or combination of the following band type:
|
||||||
|
* {@link #BAND_2GHZ}, {@link #BAND_5GHZ}, {@link #BAND_6GHZ}.
|
||||||
*/
|
*/
|
||||||
private final @BandType int mBand;
|
private final @BandType int mBand;
|
||||||
|
|
||||||
@@ -181,7 +182,11 @@ public final class SoftApConfiguration implements Parcelable {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The operating security type of the AP.
|
* The operating security type of the AP.
|
||||||
* One of the security types from {@link @SecurityType}
|
* One of the following security types:
|
||||||
|
* {@link #SECURITY_TYPE_OPEN},
|
||||||
|
* {@link #SECURITY_TYPE_WPA2_PSK},
|
||||||
|
* {@link #SECURITY_TYPE_WPA3_SAE_TRANSITION},
|
||||||
|
* {@link #SECURITY_TYPE_WPA3_SAE}
|
||||||
*/
|
*/
|
||||||
private final @SecurityType int mSecurityType;
|
private final @SecurityType int mSecurityType;
|
||||||
|
|
||||||
@@ -393,8 +398,12 @@ public final class SoftApConfiguration implements Parcelable {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns {@link BandType} set to be the band for the AP.
|
* Returns band type set to be the band for the AP.
|
||||||
* {@link Builder#setBand(@BandType int)}.
|
*
|
||||||
|
* One or combination of the following band type:
|
||||||
|
* {@link #BAND_2GHZ}, {@link #BAND_5GHZ}, {@link #BAND_6GHZ}.
|
||||||
|
*
|
||||||
|
* {@link Builder#setBand(int)}.
|
||||||
*
|
*
|
||||||
* @hide
|
* @hide
|
||||||
*/
|
*/
|
||||||
@@ -679,15 +688,19 @@ public final class SoftApConfiguration implements Parcelable {
|
|||||||
/**
|
/**
|
||||||
* Specifies that this AP should use specific security type with the given ASCII passphrase.
|
* Specifies that this AP should use specific security type with the given ASCII passphrase.
|
||||||
*
|
*
|
||||||
* @param securityType one of the security types from {@link @SecurityType}.
|
* @param securityType One of the following security types:
|
||||||
* @param passphrase The passphrase to use for sepcific {@link @SecurityType} configuration
|
* {@link #SECURITY_TYPE_OPEN},
|
||||||
* or null with {@link @SecurityType#SECURITY_TYPE_OPEN}.
|
* {@link #SECURITY_TYPE_WPA2_PSK},
|
||||||
|
* {@link #SECURITY_TYPE_WPA3_SAE_TRANSITION},
|
||||||
|
* {@link #SECURITY_TYPE_WPA3_SAE}.
|
||||||
|
* @param passphrase The passphrase to use for sepcific {@code securityType} configuration
|
||||||
|
* or null with {@link #SECURITY_TYPE_OPEN}.
|
||||||
*
|
*
|
||||||
* @return Builder for chaining.
|
* @return Builder for chaining.
|
||||||
* @throws IllegalArgumentException when the passphrase length is invalid and
|
* @throws IllegalArgumentException when the passphrase length is invalid and
|
||||||
* {@code securityType} is not {@link @SecurityType#SECURITY_TYPE_OPEN}
|
* {@code securityType} is not {@link #SECURITY_TYPE_OPEN}
|
||||||
* or non-null passphrase and {@code securityType} is
|
* or non-null passphrase and {@code securityType} is
|
||||||
* {@link @SecurityType#SECURITY_TYPE_OPEN}.
|
* {@link #SECURITY_TYPE_OPEN}.
|
||||||
*/
|
*/
|
||||||
@NonNull
|
@NonNull
|
||||||
public Builder setPassphrase(@Nullable String passphrase, @SecurityType int securityType) {
|
public Builder setPassphrase(@Nullable String passphrase, @SecurityType int securityType) {
|
||||||
@@ -735,9 +748,10 @@ public final class SoftApConfiguration implements Parcelable {
|
|||||||
/**
|
/**
|
||||||
* Specifies the band for the AP.
|
* Specifies the band for the AP.
|
||||||
* <p>
|
* <p>
|
||||||
* <li>If not set, defaults to BAND_2GHZ {@link @BandType}.</li>
|
* <li>If not set, defaults to {@link #BAND_2GHZ}.</li>
|
||||||
*
|
*
|
||||||
* @param band One or combination of the band types from {@link @BandType}.
|
* @param band One or combination of the following band type:
|
||||||
|
* {@link #BAND_2GHZ}, {@link #BAND_5GHZ}, {@link #BAND_6GHZ}.
|
||||||
* @return Builder for chaining.
|
* @return Builder for chaining.
|
||||||
*/
|
*/
|
||||||
@NonNull
|
@NonNull
|
||||||
@@ -758,7 +772,7 @@ public final class SoftApConfiguration implements Parcelable {
|
|||||||
* <p>
|
* <p>
|
||||||
* The default for the channel is a the special value 0 to have the framework
|
* The default for the channel is a the special value 0 to have the framework
|
||||||
* auto-select a valid channel from the band configured with
|
* auto-select a valid channel from the band configured with
|
||||||
* {@link #setBand(@BandType int)}.
|
* {@link #setBand(int)}.
|
||||||
*
|
*
|
||||||
* The channel auto selection will offload to driver when
|
* The channel auto selection will offload to driver when
|
||||||
* {@link SoftApCapability#areFeaturesSupported(
|
* {@link SoftApCapability#areFeaturesSupported(
|
||||||
|
|||||||
@@ -1039,11 +1039,11 @@ public class WifiNl80211Manager {
|
|||||||
* The result depends on the on the country code that has been set.
|
* The result depends on the on the country code that has been set.
|
||||||
*
|
*
|
||||||
* @param band as specified by one of the WifiScanner.WIFI_BAND_* constants.
|
* @param band as specified by one of the WifiScanner.WIFI_BAND_* constants.
|
||||||
* The following bands are supported {@link @WifiScanner.WifiBandBasic}:
|
* The following bands are supported:
|
||||||
* WifiScanner.WIFI_BAND_24_GHZ
|
* {@link WifiScanner#WIFI_BAND_24_GHZ},
|
||||||
* WifiScanner.WIFI_BAND_5_GHZ
|
* {@link WifiScanner#WIFI_BAND_5_GHZ},
|
||||||
* WifiScanner.WIFI_BAND_5_GHZ_DFS_ONLY
|
* {@link WifiScanner#WIFI_BAND_5_GHZ_DFS_ONLY},
|
||||||
* WifiScanner.WIFI_BAND_6_GHZ
|
* {@link WifiScanner#WIFI_BAND_6_GHZ}
|
||||||
* @return frequencies vector of valid frequencies (MHz), or an empty array for error.
|
* @return frequencies vector of valid frequencies (MHz), or an empty array for error.
|
||||||
* @throws IllegalArgumentException if band is not recognized.
|
* @throws IllegalArgumentException if band is not recognized.
|
||||||
*/
|
*/
|
||||||
|
|||||||
Reference in New Issue
Block a user