From 23c884ee2a761ec1e54c618fd9c04c87226fbef8 Mon Sep 17 00:00:00 2001
From: samrobinson <samrobinson@google.com>
Date: Tue, 6 Jul 2021 15:43:58 +0100
Subject: [PATCH] Add @return to the MediaDescriptionAdapter documentation.

PiperOrigin-RevId: 383268454
---
 .../android/exoplayer2/ui/PlayerNotificationManager.java  | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/library/ui/src/main/java/com/google/android/exoplayer2/ui/PlayerNotificationManager.java b/library/ui/src/main/java/com/google/android/exoplayer2/ui/PlayerNotificationManager.java
index 9e32e48019..ee632f6253 100644
--- a/library/ui/src/main/java/com/google/android/exoplayer2/ui/PlayerNotificationManager.java
+++ b/library/ui/src/main/java/com/google/android/exoplayer2/ui/PlayerNotificationManager.java
@@ -176,6 +176,7 @@ public class PlayerNotificationManager {
      * <p>See {@link NotificationCompat.Builder#setContentTitle(CharSequence)}.
      *
      * @param player The {@link Player} for which a notification is being built.
+     * @return The content title for the current media item.
      */
     CharSequence getCurrentContentTitle(Player player);
 
@@ -185,6 +186,7 @@ public class PlayerNotificationManager {
      * <p>See {@link NotificationCompat.Builder#setContentIntent(PendingIntent)}.
      *
      * @param player The {@link Player} for which a notification is being built.
+     * @return The content intent for the current media item, or null if no intent should be fired.
      */
     @Nullable
     PendingIntent createCurrentContentIntent(Player player);
@@ -195,6 +197,8 @@ public class PlayerNotificationManager {
      * <p>See {@link NotificationCompat.Builder#setContentText(CharSequence)}.
      *
      * @param player The {@link Player} for which a notification is being built.
+     * @return The content text for the current media item, or null if no context text should be
+     *     displayed.
      */
     @Nullable
     CharSequence getCurrentContentText(Player player);
@@ -205,6 +209,8 @@ public class PlayerNotificationManager {
      * <p>See {@link NotificationCompat.Builder#setSubText(CharSequence)}.
      *
      * @param player The {@link Player} for which a notification is being built.
+     * @return The content subtext for the current media item, or null if no subtext should be
+     *     displayed.
      */
     @Nullable
     default CharSequence getCurrentSubText(Player player) {
@@ -223,6 +229,8 @@ public class PlayerNotificationManager {
      *
      * @param player The {@link Player} for which a notification is being built.
      * @param callback A {@link BitmapCallback} to provide a {@link Bitmap} asynchronously.
+     * @return The large icon for the current media item, or null if the icon will be returned
+     *     through the {@link BitmapCallback} or if no icon should displayed.
      */
     @Nullable
     Bitmap getCurrentLargeIcon(Player player, BitmapCallback callback);