OSDN Git Service

docs: add a little info to Configuration class description
authorScott Main <smain@google.com>
Thu, 21 Apr 2011 05:20:46 +0000 (22:20 -0700)
committerScott Main <smain@google.com>
Thu, 21 Apr 2011 05:20:46 +0000 (22:20 -0700)
Change-Id: I3278759bd1c323330c1143ef71d0644872caa085

core/java/android/content/res/Configuration.java

index 31119d7..d20fcf9 100644 (file)
@@ -26,7 +26,11 @@ import java.util.Locale;
  * This class describes all device configuration information that can
  * impact the resources the application retrieves.  This includes both
  * user-specified configuration options (locale and scaling) as well
- * as dynamic device configuration (various types of input devices).
+ * as device configurations (such as input modes, screen size and screen orientation).
+ * <p>You can acquire this object from {@link Resources}, using {@link
+ * Resources#getConfiguration}. Thus, from an activity, you can get it by chaining the request
+ * with {@link android.app.Activity#getResources}:</p>
+ * <pre>Configuration config = getResources().getConfiguration();</pre>
  */
 public final class Configuration implements Parcelable, Comparable<Configuration> {
     /**