Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d24ffee5 authored by Christopher Tate's avatar Christopher Tate
Browse files

Tweak WallpaperManager docs 

suggestDesiredDimensions() needed a somewhat different usage note.

Also added some conspicuously absent @see references.

Bug: 130832612
Test: build 'offline-sdk-docs' & inspect the result
Change-Id: Ifb6490e4aa70d84d40b56a985e38f9a3932f7d4e
parent 0b56225e

core/java/android/app/WallpaperManager.java

+9 −6
Original line number Original line Diff line number Diff line
@@ -1564,6 +1564,8 @@ public class WallpaperManager { 
     * @return The desired minimum width for the wallpaper. This value should

     * @return The desired minimum width for the wallpaper. This value should

     * be honored by applications that set the wallpaper but it is not

     * be honored by applications that set the wallpaper but it is not

     * mandatory.

     * mandatory.

     *

     * @see #getDesiredMinimumHeight()

     */

     */

    public int getDesiredMinimumWidth() {

    public int getDesiredMinimumWidth() {

        if (sGlobals.mService == null) {

        if (sGlobals.mService == null) {
@@ -1590,6 +1592,8 @@ public class WallpaperManager { 
     * @return The desired minimum height for the wallpaper. This value should

     * @return The desired minimum height for the wallpaper. This value should

     * be honored by applications that set the wallpaper but it is not

     * be honored by applications that set the wallpaper but it is not

     * mandatory.

     * mandatory.

     *

     * @see #getDesiredMinimumWidth()

     */

     */

    public int getDesiredMinimumHeight() {

    public int getDesiredMinimumHeight() {

        if (sGlobals.mService == null) {

        if (sGlobals.mService == null) {
@@ -1609,12 +1613,11 @@ public class WallpaperManager { 
     * a virtual wallpaper that is larger than the physical screen, matching

     * a virtual wallpaper that is larger than the physical screen, matching

     * the size of their workspace.

     * the size of their workspace.

     *

     *

     * <p>Note developers, who don't seem to be reading this.  This is

     * <p class="note">Calling this method from apps other than the active

     * for <em>home apps</em> to tell what size wallpaper they would like.

     * home app is not guaranteed to work properly.  Other apps that supply

     * Nobody else should be calling this!  Certainly not other non-home

     * wallpaper imagery should use {@link #getDesiredMinimumWidth()} and

     * apps that change the wallpaper.  Those apps are supposed to

     * {@link #getDesiredMinimumHeight()} and construct a wallpaper that

     * <b>retrieve</b> the suggested size so they can construct a wallpaper

     * matches those dimensions.

     * that matches it.

     *

     *

     * <p>This method requires the caller to hold the permission

     * <p>This method requires the caller to hold the permission

     * {@link android.Manifest.permission#SET_WALLPAPER_HINTS}.

     * {@link android.Manifest.permission#SET_WALLPAPER_HINTS}.