Merge "Add a little comment about the enabled value" into klp-dev

This commit is contained in:
Tom O'Neill
2013-08-23 02:00:28 +00:00
committed by Android (Google) Code Review

View File

@@ -176,8 +176,15 @@ public abstract class SettingInjectorService extends IntentService {
/**
* Constructor.
* <p/>
* Note that to prevent churn in the settings list, there is no support for dynamically
* choosing to hide a setting. Instead you should provide a {@code enabled} value of false,
* which will gray the setting out and disable the link from "Settings > Location"
* to your setting activity. One reason why you might choose to do this is if
* {@link android.provider.Settings.Secure#getLocationMode(android.content.ContentResolver)}
* is {@link android.provider.Settings.Secure#LOCATION_MODE_OFF}.
*
* @param summary the {@link Preference#getSummary()} value
* @param summary the {@link Preference#getSummary()} value (allowed to be null or empty)
* @param enabled the {@link Preference#isEnabled()} value
*/
public Status(String summary, boolean enabled) {