Enable TreatWarningsAsErrors for MediaBrowser.MediaEncoding

MediaBrowser.MediaEncoding/Attachments/AttachmentExtractor.cs

@@ -1,3 +1,5 @@
+#pragma warning disable CS1591
+
 using System;
 using System.Collections.Concurrent;
 using System.Diagnostics;

MediaBrowser.MediaEncoding/BdInfo/BdInfoExaminer.cs

@@ -15,6 +15,10 @@ namespace MediaBrowser.MediaEncoding.BdInfo
     {
         private readonly IFileSystem _fileSystem;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="BdInfoExaminer" /> class.
+        /// </summary>
+        /// <param name="fileSystem">The filesystem.</param>
         public BdInfoExaminer(IFileSystem fileSystem)
         {
             _fileSystem = fileSystem;

MediaBrowser.MediaEncoding/Configuration/EncodingConfigurationFactory.cs

@@ -1,3 +1,5 @@
+#pragma warning disable CS1591
+
 using System;
 using System.Collections.Generic;
 using System.Globalization;

MediaBrowser.MediaEncoding/Encoder/EncoderValidator.cs

@@ -1,3 +1,5 @@
+#pragma warning disable CS1591
+
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;

MediaBrowser.MediaEncoding/Encoder/EncodingUtils.cs

@@ -1,3 +1,5 @@
+#pragma warning disable CS1591
+
 using System.Collections.Generic;
 using System.Linq;
 using MediaBrowser.Model.MediaInfo;

MediaBrowser.MediaEncoding/Encoder/MediaEncoder.cs

@@ -1,3 +1,5 @@
+#pragma warning disable CS1591
+
 using System;
 using System.Collections.Generic;
 using System.Globalization;

MediaBrowser.MediaEncoding/MediaBrowser.MediaEncoding.csproj

@@ -9,6 +9,7 @@
     <TargetFramework>netstandard2.1</TargetFramework>
     <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
   </PropertyGroup>
 
   <ItemGroup>

MediaBrowser.MediaEncoding/Probing/FFProbeHelpers.cs

@@ -3,6 +3,9 @@ using System.Collections.Generic;
 
 namespace MediaBrowser.MediaEncoding.Probing
 {
+    /// <summary>
+    /// Class containing helper methods for working with FFprobe output.
+    /// </summary>
     public static class FFProbeHelpers
     {
         /// <summary>

MediaBrowser.MediaEncoding/Probing/MediaChapter.cs

@@ -1,3 +1,5 @@
+#pragma warning disable CS1591
+
 using System.Collections.Generic;
 using System.Text.Json.Serialization;
 

MediaBrowser.MediaEncoding/Probing/MediaStreamInfo.cs

@@ -269,6 +269,10 @@ namespace MediaBrowser.MediaEncoding.Probing
         [JsonPropertyName("loro_surmixlev")]
         public string LoroSurmixlev { get; set; }
 
+        /// <summary>
+        /// Gets or sets the field_order.
+        /// </summary>
+        /// <value>The loro_surmixlev.</value>
         [JsonPropertyName("field_order")]
         public string FieldOrder { get; set; }
 

MediaBrowser.MediaEncoding/Probing/ProbeResultNormalizer.cs

@@ -1,3 +1,5 @@
+#pragma warning disable CS1591
+
 using System;
 using System.Collections.Generic;
 using System.Globalization;

MediaBrowser.MediaEncoding/Subtitles/AssParser.cs

@@ -1,3 +1,5 @@
+#pragma warning disable CS1591
+
 using System;
 using System.Collections.Generic;
 using System.Globalization;
@@ -13,6 +15,7 @@ namespace MediaBrowser.MediaEncoding.Subtitles
     {
         private readonly CultureInfo _usCulture = new CultureInfo("en-US");
 
+        /// <inheritdoc />
         public SubtitleTrackInfo Parse(Stream stream, CancellationToken cancellationToken)
         {
             var trackInfo = new SubtitleTrackInfo();

MediaBrowser.MediaEncoding/Subtitles/ISubtitleParser.cs

@@ -1,3 +1,5 @@
+#pragma warning disable CS1591
+
 using System.IO;
 using System.Threading;
 using MediaBrowser.Model.MediaInfo;

MediaBrowser.MediaEncoding/Subtitles/SubtitleEncoder.cs

@@ -380,6 +380,7 @@ namespace MediaBrowser.MediaEncoding.Subtitles
         /// Converts the text subtitle to SRT.
         /// </summary>
         /// <param name="inputPath">The input path.</param>
+        /// <param name="language">The language.</param>
         /// <param name="inputProtocol">The input protocol.</param>
         /// <param name="outputPath">The output path.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
@@ -407,14 +408,13 @@ namespace MediaBrowser.MediaEncoding.Subtitles
         /// Converts the text subtitle to SRT internal.
         /// </summary>
         /// <param name="inputPath">The input path.</param>
+        /// <param name="language">The language.</param>
         /// <param name="inputProtocol">The input protocol.</param>
         /// <param name="outputPath">The output path.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>Task.</returns>
         /// <exception cref="ArgumentNullException">
-        /// inputPath
+        /// The <c>inputPath</c> or <c>outputPath</c> is <c>null</c>
-        /// or
-        /// outputPath
         /// </exception>
         private async Task ConvertTextSubtitleToSrtInternal(string inputPath, string language, MediaProtocol inputProtocol, string outputPath, CancellationToken cancellationToken)
         {