summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Andrew Solovay <asolovay@google.com> 2019-08-28 13:18:04 -0700
committer android-build-merger <android-build-merger@google.com> 2019-08-28 13:18:04 -0700
commit033de4e8c27d447d627aee39915a372144d8a57b (patch)
tree550a8ed9517fe07f3343abecfcdf611c9ebce721
parentf03f803aafa9a3120040ed1a458374b9648c2e0f (diff)
parent3791f9b071ba271228898a6100be36ac0f80dab4 (diff)
Merge "Docs: clarify getSharedPreferences behavior" into qt-dev
am: 3791f9b071 Change-Id: Ia631eefc35816b92004a3fa6f8ad5f00236908bf
-rw-r--r--core/java/android/content/Context.java13
1 files changed, 9 insertions, 4 deletions
diff --git a/core/java/android/content/Context.java b/core/java/android/content/Context.java
index a6b95a95dcd8..4a5ea03b4530 100644
--- a/core/java/android/content/Context.java
+++ b/core/java/android/content/Context.java
@@ -854,11 +854,16 @@ public abstract class Context {
* to any callers for the same name, meaning they will see each other's
* edits as soon as they are made.
*
- * This method is thead-safe.
+ * <p>This method is thread-safe.
*
- * @param name Desired preferences file. If a preferences file by this name
- * does not exist, it will be created when you retrieve an
- * editor (SharedPreferences.edit()) and then commit changes (Editor.commit()).
+ * <p>If the preferences directory does not already exist, it will be created when this method
+ * is called.
+ *
+ * <p>If a preferences file by this name does not exist, it will be created when you retrieve an
+ * editor ({@link SharedPreferences#edit()}) and then commit changes ({@link
+ * SharedPreferences.Editor#commit()} or {@link SharedPreferences.Editor#apply()}).
+ *
+ * @param name Desired preferences file.
* @param mode Operating mode.
*
* @return The single {@link SharedPreferences} instance that can be used