Merge pull request #6412 from richlander/mediabrowser-controller-session

MediaBrowser.Controller/Session/ISessionController.cs

@@ -26,6 +26,12 @@ namespace MediaBrowser.Controller.Session
         /// <summary>
         /// Sends the message.
         /// </summary>
+        /// <typeparam name="T">The type of data.</typeparam>
+        /// <param name="name">Name of message type.</param>
+        /// <param name="messageId">Message ID.</param>
+        /// <param name="data">Data to send.</param>
+        /// <param name="cancellationToken">CancellationToken for operation.</param>
+        /// <returns>A task.</returns>
         Task SendMessage<T>(SessionMessageType name, Guid messageId, T data, CancellationToken cancellationToken);
     }
 }

MediaBrowser.Controller/Session/ISessionManager.cs

@@ -83,6 +83,7 @@ namespace MediaBrowser.Controller.Session
         /// <param name="deviceName">Name of the device.</param>
         /// <param name="remoteEndPoint">The remote end point.</param>
         /// <param name="user">The user.</param>
+        /// <returns>Session information.</returns>
         SessionInfo LogSessionActivity(string appName, string appVersion, string deviceId, string deviceName, string remoteEndPoint, Jellyfin.Data.Entities.User user);
 
         /// <summary>
@@ -105,7 +106,7 @@ namespace MediaBrowser.Controller.Session
         /// </summary>
         /// <param name="info">The info.</param>
         /// <returns>Task.</returns>
-        /// <exception cref="ArgumentNullException"></exception>
+        /// <exception cref="ArgumentNullException">Throws if an argument is null.</exception>
         Task OnPlaybackProgress(PlaybackProgressInfo info);
 
         Task OnPlaybackProgress(PlaybackProgressInfo info, bool isAutomated);
@@ -115,14 +116,13 @@ namespace MediaBrowser.Controller.Session
         /// </summary>
         /// <param name="info">The info.</param>
         /// <returns>Task.</returns>
-        /// <exception cref="ArgumentNullException"></exception>
+        /// <exception cref="ArgumentNullException">Throws if an argument is null.</exception>
         Task OnPlaybackStopped(PlaybackStopInfo info);
 
         /// <summary>
         /// Reports the session ended.
         /// </summary>
         /// <param name="sessionId">The session identifier.</param>
-        /// <returns>Task.</returns>
         void ReportSessionEnded(string sessionId);
 
         /// <summary>
@@ -170,6 +170,7 @@ namespace MediaBrowser.Controller.Session
         /// <param name="session">The session.</param>
         /// <param name="command">The group update.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
+        /// <typeparam name="T">Type of group.</typeparam>
         /// <returns>Task.</returns>
         Task SendSyncPlayGroupUpdate<T>(SessionInfo session, GroupUpdate<T> command, CancellationToken cancellationToken);
 
@@ -196,8 +197,8 @@ namespace MediaBrowser.Controller.Session
         /// <summary>
         /// Sends the message to admin sessions.
         /// </summary>
-        /// <typeparam name="T"></typeparam>
-        /// <param name="name">The name.</param>
+        /// <typeparam name="T">Type of data.</typeparam>
+        /// <param name="name">Message type name.</param>
         /// <param name="data">The data.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>Task.</returns>
@@ -206,18 +207,31 @@ namespace MediaBrowser.Controller.Session
         /// <summary>
         /// Sends the message to user sessions.
         /// </summary>
-        /// <typeparam name="T"></typeparam>
+        /// <typeparam name="T">Type of data.</typeparam>
+        /// <param name="userIds">Users to send messages to.</param>
+        /// <param name="name">Message type name.</param>
+        /// <param name="data">The data.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>Task.</returns>
         Task SendMessageToUserSessions<T>(List<Guid> userIds, SessionMessageType name, T data, CancellationToken cancellationToken);
 
+        /// <summary>
+        /// Sends the message to user sessions.
+        /// </summary>
+        /// <typeparam name="T">Type of data.</typeparam>
+        /// <param name="userIds">Users to send messages to.</param>
+        /// <param name="name">Message type name.</param>
+        /// <param name="dataFn">Data function.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        /// <returns>Task.</returns>
         Task SendMessageToUserSessions<T>(List<Guid> userIds, SessionMessageType name, Func<T> dataFn, CancellationToken cancellationToken);
 
         /// <summary>
         /// Sends the message to user device sessions.
         /// </summary>
-        /// <typeparam name="T"></typeparam>
+        /// <typeparam name="T">Type of data.</typeparam>
         /// <param name="deviceId">The device identifier.</param>
-        /// <param name="name">The name.</param>
+        /// <param name="name">Message type name.</param>
         /// <param name="data">The data.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>Task.</returns>
@@ -353,6 +367,8 @@ namespace MediaBrowser.Controller.Session
         /// <summary>
         /// Revokes the user tokens.
         /// </summary>
+        /// <param name="userId">User ID.</param>
+        /// <param name="currentAccessToken">Current access token.</param>
         void RevokeUserTokens(Guid userId, string currentAccessToken);
 
         /// <summary>