summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--core/java/android/app/WallpaperManager.java15
1 files changed, 9 insertions, 6 deletions
diff --git a/core/java/android/app/WallpaperManager.java b/core/java/android/app/WallpaperManager.java
index 9ad3d38a3084..a88500920e97 100644
--- a/core/java/android/app/WallpaperManager.java
+++ b/core/java/android/app/WallpaperManager.java
@@ -1564,6 +1564,8 @@ public class WallpaperManager {
* @return The desired minimum width for the wallpaper. This value should
* be honored by applications that set the wallpaper but it is not
* mandatory.
+ *
+ * @see #getDesiredMinimumHeight()
*/
public int getDesiredMinimumWidth() {
if (sGlobals.mService == null) {
@@ -1590,6 +1592,8 @@ public class WallpaperManager {
* @return The desired minimum height for the wallpaper. This value should
* be honored by applications that set the wallpaper but it is not
* mandatory.
+ *
+ * @see #getDesiredMinimumWidth()
*/
public int getDesiredMinimumHeight() {
if (sGlobals.mService == null) {
@@ -1609,12 +1613,11 @@ public class WallpaperManager {
* a virtual wallpaper that is larger than the physical screen, matching
* the size of their workspace.
*
- * <p>Note developers, who don't seem to be reading this. This is
- * for <em>home apps</em> to tell what size wallpaper they would like.
- * Nobody else should be calling this! Certainly not other non-home
- * apps that change the wallpaper. Those apps are supposed to
- * <b>retrieve</b> the suggested size so they can construct a wallpaper
- * that matches it.
+ * <p class="note">Calling this method from apps other than the active
+ * home app is not guaranteed to work properly. Other apps that supply
+ * wallpaper imagery should use {@link #getDesiredMinimumWidth()} and
+ * {@link #getDesiredMinimumHeight()} and construct a wallpaper that
+ * matches those dimensions.
*
* <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#SET_WALLPAPER_HINTS}.