Browse Source

Address suppressed warnings

Joe Rogers 3 years ago
parent
commit
1df5b5034b
1 changed files with 29 additions and 4 deletions
  1. 29 4
      MediaBrowser.Providers/MediaInfo/SubtitleResolver.cs

+ 29 - 4
MediaBrowser.Providers/MediaInfo/SubtitleResolver.cs

@@ -1,7 +1,3 @@
-#nullable disable
-
-#pragma warning disable CA1002, CS1591
-
 using System;
 using System.Collections.Generic;
 using System.IO;
@@ -12,15 +8,30 @@ using MediaBrowser.Model.Globalization;
 
 namespace MediaBrowser.Providers.MediaInfo
 {
+    /// <summary>
+    /// Resolves external subtitles for videos.
+    /// </summary>
     public class SubtitleResolver
     {
         private readonly ILocalizationManager _localization;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SubtitleResolver"/> class.
+        /// </summary>
+        /// <param name="localization">The localization manager.</param>
         public SubtitleResolver(ILocalizationManager localization)
         {
             _localization = localization;
         }
 
+        /// <summary>
+        /// Retrieves the external subtitle streams for the provided video.
+        /// </summary>
+        /// <param name="video">The video to search from.</param>
+        /// <param name="startIndex">The stream index to start adding subtitle streams at.</param>
+        /// <param name="directoryService">The directory service to search for files.</param>
+        /// <param name="clearCache">True if the directory service cache should be cleared before searching.</param>
+        /// <returns>The external subtitle streams located.</returns>
         public List<MediaStream> GetExternalSubtitleStreams(
             Video video,
             int startIndex,
@@ -56,6 +67,13 @@ namespace MediaBrowser.Providers.MediaInfo
             return streams;
         }
 
+        /// <summary>
+        /// Locates the external subtitle files for the provided video.
+        /// </summary>
+        /// <param name="video">The video to search from.</param>
+        /// <param name="directoryService">The directory service to search for files.</param>
+        /// <param name="clearCache">True if the directory service cache should be cleared before searching.</param>
+        /// <returns>The external subtitle file paths located.</returns>
         public IEnumerable<string> GetExternalSubtitleFiles(
             Video video,
             IDirectoryService directoryService,
@@ -74,6 +92,13 @@ namespace MediaBrowser.Providers.MediaInfo
             }
         }
 
+        /// <summary>
+        /// Extracts the subtitle files from the provided list and adds them to the list of streams.
+        /// </summary>
+        /// <param name="streams">The list of streams to add external subtitles to.</param>
+        /// <param name="videoPath">The path to the video file.</param>
+        /// <param name="startIndex">The stream index to start adding subtitle streams at.</param>
+        /// <param name="files">The files to add if they are subtitles.</param>
         public void AddExternalSubtitleStreams(
             List<MediaStream> streams,
             string videoPath,