From 2a3ebadcbe051a151909625be3847b38824ce0fe Mon Sep 17 00:00:00 2001 From: Dave Friedman Date: Wed, 4 Jan 2017 18:27:26 -0800 Subject: Docs: Updates Javadoc documentation. Bug: 32532540 Change-Id: Ia811d9a51812206b18b75a98f6c5a55b92627404 --- core/java/android/app/ActivityManager.java | 34 +++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/core/java/android/app/ActivityManager.java b/core/java/android/app/ActivityManager.java index c96bd39eeffe..795b1f3e68d6 100644 --- a/core/java/android/app/ActivityManager.java +++ b/core/java/android/app/ActivityManager.java @@ -75,7 +75,39 @@ import java.util.ArrayList; import java.util.List; /** - * Interact with the overall activities running in the system. + *

+ * This class gives information about, and interacts + * with, activities, services, and the containing + * process. + *

+ * + *

+ * A number of the methods in this class are for + * debugging or informational purposes and they should + * not be used to affect any runtime behavior of + * your app. These methods are called out as such in + * the method level documentation. + *

+ * + *

+ * Most application developers should not have the need to + * use this class, most of whose methods are for specialized + * use cases. However, a few methods are more broadly applicable. + * For instance, {@link android.app.ActivityManager#isLowRamDevice() isLowRamDevice()} + * enables your app to detect whether it is running on a low-memory device, + * and behave accordingly. + * {@link android.app.ActivityManager#clearApplicationUserData() clearApplicationUserData()} + * is for apps with reset-data functionality. + *

+ * + *

+ * In some special use cases, where an app interacts with + * its Task stack, the app may use the + * {@link android.app.ActivityManager.AppTask} and + * {@link android.app.ActivityManager.RecentTaskInfo} inner + * classes. However, in general, the methods in this class should + * be used for testing and debugging purposes only. + *

*/ public class ActivityManager { private static String TAG = "ActivityManager"; -- cgit v1.2.3-59-g8ed1b