Update javadoc on BatterySaverPolicyConfig

Change-Id: I21a536a603174ee859b49689f4a16184adab6813
Fix: 129473934
Test: Treehugger
This commit is contained in:
Makoto Onuki
2019-04-01 12:56:27 -07:00
parent 8502e24cd3
commit c458c07dd3

View File

@@ -240,7 +240,10 @@ public final class BatterySaverPolicyConfig implements Parcelable {
return mDisableOptionalSensors;
}
/** Whether or not to disable sound trigger while in Battery Saver. */
/**
* Whether or not to disable {@link android.hardware.soundtrigger.SoundTrigger}
* while in Battery Saver.
*/
public boolean getDisableSoundTrigger() {
return mDisableSoundTrigger;
}
@@ -260,7 +263,10 @@ public final class BatterySaverPolicyConfig implements Parcelable {
return mEnableDataSaver;
}
/** Whether or not to enable the network firewall while in Battery Saver. */
/**
* Whether or not to enable network firewall rules to restrict background network use
* while in Battery Saver.
*/
public boolean getEnableFirewall() {
return mEnableFirewall;
}
@@ -280,7 +286,12 @@ public final class BatterySaverPolicyConfig implements Parcelable {
return mForceAllAppsStandby;
}
/** Whether or not to force background check while in Battery Saver. */
/**
* Whether or not to force background check (disallow background services and manifest
* broadcast receivers) on all apps (not just apps targeting Android
* {@link Build.VERSION_CODES#O} and above)
* while in Battery Saver.
*/
public boolean getForceBackgroundCheck() {
return mForceBackgroundCheck;
}
@@ -400,7 +411,10 @@ public final class BatterySaverPolicyConfig implements Parcelable {
return this;
}
/** Set whether or not to disable sound trigger while in Battery Saver. */
/**
* Set whether or not to disable {@link android.hardware.soundtrigger.SoundTrigger}
* while in Battery Saver.
*/
@NonNull
public Builder setDisableSoundTrigger(boolean disableSoundTrigger) {
mDisableSoundTrigger = disableSoundTrigger;
@@ -428,7 +442,10 @@ public final class BatterySaverPolicyConfig implements Parcelable {
return this;
}
/** Set whether or not to enable the network firewall while in Battery Saver. */
/**
* Set whether or not to enable network firewall rules to restrict background network use
* while in Battery Saver.
*/
@NonNull
public Builder setEnableFirewall(boolean enableFirewall) {
mEnableFirewall = enableFirewall;
@@ -456,7 +473,12 @@ public final class BatterySaverPolicyConfig implements Parcelable {
return this;
}
/** Set whether or not to force background check while in Battery Saver. */
/**
* Set whether or not to force background check (disallow background services and manifest
* broadcast receivers) on all apps (not just apps targeting Android
* {@link Build.VERSION_CODES#O} and above)
* while in Battery Saver.
*/
@NonNull
public Builder setForceBackgroundCheck(boolean forceBackgroundCheck) {
mForceBackgroundCheck = forceBackgroundCheck;