diff options
author | Jaewan Kim <jaewan@google.com> | 2019-07-03 14:55:55 +0900 |
---|---|---|
committer | Jaewan Kim <jaewan@google.com> | 2019-07-03 14:55:55 +0900 |
commit | db90afdb78b1666121b632df82001fd7846f2305 (patch) | |
tree | 4bb2b49e3178bc97e86bc3174ac2cee0aea52995 | |
parent | f3e269ce2155e5c254b99123f8e151edbe7b6aa2 (diff) | |
download | base-db90afdb78b1666121b632df82001fd7846f2305.tar.gz |
Media2: Make Javadoc consistent for recommending use of AndroidX
Bug: 136602530
Test: Build docs offline and checked manually.
Change-Id: I70df7b05a6749b9ba492ac03cd3b9179a7416b9c
7 files changed, 100 insertions, 52 deletions
diff --git a/media/apex/java/android/media/MediaController2.java b/media/apex/java/android/media/MediaController2.java index 63a4510e7fe7..c3dd3fe4451c 100644 --- a/media/apex/java/android/media/MediaController2.java +++ b/media/apex/java/android/media/MediaController2.java @@ -46,14 +46,14 @@ import android.util.Log; import java.util.concurrent.Executor; /** + * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * * Allows an app to interact with an active {@link MediaSession2} or a * {@link MediaSession2Service} which would provide {@link MediaSession2}. Media buttons and other * commands can be sent to the session. - * <p> - * This API is not generally intended for third party application developers. - * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> - * <a href="{@docRoot}reference/androidx/media2/package-summary.html">Media2 Library</a> - * for consistent behavior across all devices. */ public class MediaController2 implements AutoCloseable { static final String TAG = "MediaController2"; @@ -405,6 +405,11 @@ public class MediaController2 implements AutoCloseable { } /** + * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> * Builder for {@link MediaController2}. * <p> * Any incoming event from the {@link MediaSession2} will be handled on the callback @@ -502,9 +507,12 @@ public class MediaController2 implements AutoCloseable { } /** - * Interface for listening to change in activeness of the {@link MediaSession2}. - * <p> * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> + * Interface for listening to change in activeness of the {@link MediaSession2}. */ public abstract static class ControllerCallback { /** diff --git a/media/apex/java/android/media/MediaSession2.java b/media/apex/java/android/media/MediaSession2.java index b3edf3f50866..081e76ab0215 100644 --- a/media/apex/java/android/media/MediaSession2.java +++ b/media/apex/java/android/media/MediaSession2.java @@ -52,13 +52,13 @@ import java.util.Objects; import java.util.concurrent.Executor; /** - * Allows a media app to expose its transport controls and playback information in a process to - * other processes including the Android framework and other apps. - * <p> * This API is not generally intended for third party application developers. * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> - * <a href="{@docRoot}reference/androidx/media2/package-summary.html">Media2 Library</a> - * for consistent behavior across all devices. + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> + * Allows a media app to expose its transport controls and playback information in a process to + * other processes including the Android framework and other apps. */ public class MediaSession2 implements AutoCloseable { static final String TAG = "MediaSession2"; @@ -481,6 +481,11 @@ public class MediaSession2 implements AutoCloseable { } /** + * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> * Builder for {@link MediaSession2}. * <p> * Any incoming event from the {@link MediaController2} will be handled on the callback @@ -616,9 +621,12 @@ public class MediaSession2 implements AutoCloseable { } /** - * Information of a controller. - * <p> * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> + * Information of a controller. */ public static final class ControllerInfo { private final RemoteUserInfo mRemoteUserInfo; @@ -807,9 +815,12 @@ public class MediaSession2 implements AutoCloseable { } /** - * Callback to be called for all incoming commands from {@link MediaController2}s. - * <p> * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> + * Callback to be called for all incoming commands from {@link MediaController2}s. */ public abstract static class SessionCallback { /** diff --git a/media/apex/java/android/media/MediaSession2Service.java b/media/apex/java/android/media/MediaSession2Service.java index ee584e5eac30..f6fd509fd245 100644 --- a/media/apex/java/android/media/MediaSession2Service.java +++ b/media/apex/java/android/media/MediaSession2Service.java @@ -44,12 +44,12 @@ import java.util.List; import java.util.Map; /** - * Service containing {@link MediaSession2}. - * <p> * This API is not generally intended for third party application developers. * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> - * <a href="{@docRoot}reference/androidx/media2/package-summary.html">Media2 Library</a> - * for consistent behavior across all devices. + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> + * Service containing {@link MediaSession2}. */ public abstract class MediaSession2Service extends Service { /** @@ -287,6 +287,11 @@ public abstract class MediaSession2Service extends Service { } /** + * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> * Returned by {@link #onUpdateNotification(MediaSession2)} for making session service * foreground service to keep playback running in the background. It's highly recommended to * show media style notification here. diff --git a/media/apex/java/android/media/Session2Command.java b/media/apex/java/android/media/Session2Command.java index 7c752e198f3a..26f4568fa7e5 100644 --- a/media/apex/java/android/media/Session2Command.java +++ b/media/apex/java/android/media/Session2Command.java @@ -26,6 +26,11 @@ import android.text.TextUtils; import java.util.Objects; /** + * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> * Define a command that a {@link MediaController2} can send to a {@link MediaSession2}. * <p> * If {@link #getCommandCode()} isn't {@link #COMMAND_CODE_CUSTOM}), it's predefined command. @@ -35,11 +40,6 @@ import java.util.Objects; * Refer to the * <a href="{@docRoot}reference/androidx/media2/SessionCommand2.html">AndroidX SessionCommand</a> * class for the list of valid commands. - * <p> - * This API is not generally intended for third party application developers. - * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> - * <a href="{@docRoot}reference/androidx/media2/package-summary.html">Media2 Library</a> - * for consistent behavior across all devices. */ public final class Session2Command implements Parcelable { /** @@ -162,6 +162,11 @@ public final class Session2Command implements Parcelable { } /** + * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> * Contains the result of {@link Session2Command}. */ public static final class Result { diff --git a/media/apex/java/android/media/Session2CommandGroup.java b/media/apex/java/android/media/Session2CommandGroup.java index 06ae8737fdc0..0ee5f62be128 100644 --- a/media/apex/java/android/media/Session2CommandGroup.java +++ b/media/apex/java/android/media/Session2CommandGroup.java @@ -28,13 +28,12 @@ import java.util.HashSet; import java.util.Set; /** - * A set of {@link Session2Command} which represents a command group. - * <p> * This API is not generally intended for third party application developers. * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> - * <a href="{@docRoot}reference/androidx/media2/package-summary.html">Media2 Library</a> - * for consistent behavior across all devices. - * </p> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> + * A set of {@link Session2Command} which represents a command group. */ public final class Session2CommandGroup implements Parcelable { private static final String TAG = "Session2CommandGroup"; @@ -131,6 +130,11 @@ public final class Session2CommandGroup implements Parcelable { } /** + * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> * Builds a {@link Session2CommandGroup} object. */ public static final class Builder { diff --git a/media/apex/java/android/media/Session2Token.java b/media/apex/java/android/media/Session2Token.java index 6d499fa88815..6eb76b11497e 100644 --- a/media/apex/java/android/media/Session2Token.java +++ b/media/apex/java/android/media/Session2Token.java @@ -36,13 +36,13 @@ import java.util.List; import java.util.Objects; /** - * Represents an ongoing {@link MediaSession2} or a {@link MediaSession2Service}. - * If it's representing a session service, it may not be ongoing. - * <p> * This API is not generally intended for third party application developers. * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> - * <a href="{@docRoot}reference/androidx/media2/package-summary.html">Media2 Library</a> - * for consistent behavior across all devices. + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> + * Represents an ongoing {@link MediaSession2} or a {@link MediaSession2Service}. + * If it's representing a session service, it may not be ongoing. * <p> * This may be passed to apps by the session owner to allow them to create a * {@link MediaController2} to communicate with the session. diff --git a/media/java/android/media/session/MediaSessionManager.java b/media/java/android/media/session/MediaSessionManager.java index 569d11e1dce6..dec0140c0d5c 100644 --- a/media/java/android/media/session/MediaSessionManager.java +++ b/media/java/android/media/session/MediaSessionManager.java @@ -119,6 +119,11 @@ public final class MediaSessionManager { } /** + * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> * Notifies that a new {@link MediaSession2} with type {@link Session2Token#TYPE_SESSION} is * created. * <p> @@ -192,6 +197,11 @@ public final class MediaSessionManager { } /** + * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> * Gets a list of {@link Session2Token} with type {@link Session2Token#TYPE_SESSION} for the * current user. * <p> @@ -335,12 +345,12 @@ public final class MediaSessionManager { } /** - * Adds a listener to be notified when the {@link #getSession2Tokens()} changes. - * <p> * This API is not generally intended for third party application developers. * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> - * <a href="{@docRoot}reference/androidx/media2/package-summary.html">Media2 Library</a> - * for consistent behavior across all devices. + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> + * Adds a listener to be notified when the {@link #getSession2Tokens()} changes. * * @param listener The listener to add */ @@ -350,12 +360,12 @@ public final class MediaSessionManager { } /** - * Adds a listener to be notified when the {@link #getSession2Tokens()} changes. - * <p> * This API is not generally intended for third party application developers. * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> - * <a href="{@docRoot}reference/androidx/media2/package-summary.html">Media2 Library</a> - * for consistent behavior across all devices. + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> + * Adds a listener to be notified when the {@link #getSession2Tokens()} changes. * * @param listener The listener to add * @param handler The handler to call listener on. @@ -366,12 +376,12 @@ public final class MediaSessionManager { } /** - * Adds a listener to be notified when the {@link #getSession2Tokens()} changes. - * <p> * This API is not generally intended for third party application developers. * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> - * <a href="{@docRoot}reference/androidx/media2/package-summary.html">Media2 Library</a> - * for consistent behavior across all devices. + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> + * Adds a listener to be notified when the {@link #getSession2Tokens()} changes. * * @param userId The userId to listen for changes on * @param listener The listener to add @@ -402,6 +412,11 @@ public final class MediaSessionManager { } /** + * This API is not generally intended for third party application developers. + * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> * Removes the {@link OnSession2TokensChangedListener} to stop receiving session token updates. * * @param listener The listener to remove. @@ -765,13 +780,13 @@ public final class MediaSessionManager { } /** - * Listens for changes to the {@link #getSession2Tokens()}. This can be added - * using {@link #addOnSession2TokensChangedListener(OnSession2TokensChangedListener, Handler)}. - * <p> * This API is not generally intended for third party application developers. * Use the <a href="{@docRoot}jetpack/androidx.html">AndroidX</a> - * <a href="{@docRoot}reference/androidx/media2/package-summary.html">Media2 Library</a> - * for consistent behavior across all devices. + * <a href="{@docRoot}reference/androidx/media2/session/package-summary.html">Media2 session + * Library</a> for consistent behavior across all devices. + * <p> + * Listens for changes to the {@link #getSession2Tokens()}. This can be added + * using {@link #addOnSession2TokensChangedListener(OnSession2TokensChangedListener, Handler)}. */ public interface OnSession2TokensChangedListener { /** |