Small QoL improvements

Wkhtmltopdf.NetCore.Test/SmokeTest.cs

@@ -13,17 +13,17 @@ public class SmokeTest
         [SetUp]
         public void SetRotativaPath()
         {
-#pragma warning disable 612
+#pragma warning disable 618
             WkhtmltopdfConfiguration.RotativaPath = AppDomain.CurrentDomain.BaseDirectory + "Rotativa";
-#pragma warning restore 612
+#pragma warning restore 618
         }
 
         [TearDown]
         public void ClearRotativaPath()
         {
-#pragma warning disable 612
+#pragma warning disable 618
             WkhtmltopdfConfiguration.RotativaPath = null;
-#pragma warning restore 612
+#pragma warning restore 618
         }
 
         [Test]
@@ -55,9 +55,9 @@ public void LegacyResolutionWorks()
             using var host = Host.CreateDefaultBuilder()
                 .ConfigureWebHostDefaults(webBuilder =>
                 {
-#pragma warning disable 612
+#pragma warning disable 618
                     webBuilder.ConfigureServices(services => services.AddWkhtmltopdf());
-#pragma warning restore 612
+#pragma warning restore 618
                 })
                 .Build();
 

Wkhtmltopdf.NetCore/Configuration/ExactPathProvider.cs

@@ -16,7 +16,7 @@ public ExactPathProvider(string path = "wkhtmltopdf")
             _path = path;
         }
 
-        /* <inheritDoc /> */
+        /** <inheritDoc /> */
         public string GetPath() => _path;
     }
 }

Wkhtmltopdf.NetCore/Configuration/Interfaces/IWkhtmltopdfPathProvider.cs

@@ -1,5 +1,8 @@
 namespace Wkhtmltopdf.NetCore
 {
+    /// <summary>
+    /// Provides path to wkhtmltopdf.
+    /// </summary>
     public interface IWkhtmltopdfPathProvider
     {
         /// <summary>

Wkhtmltopdf.NetCore/Configuration/LegacyPathProvider.cs

@@ -12,7 +12,7 @@ public class LegacyPathProvider : IWkhtmltopdfPathProvider
         private readonly string _rotativaLocation;
 
         /// <summary>
-        ///     Constructs path from <see cref="AppDomain.CurrentDomain" />'s base directory, <see cref="wkhtmltopdfRelativePath" />,
+        ///     Constructs path from <see cref="AppDomain.CurrentDomain" />'s base directory, <paramref name="wkhtmltopdfRelativePath"/> />,
         ///     <para />
         ///     OS dependent folder and executable name.
         /// </summary>
@@ -45,7 +45,7 @@ public LegacyPathProvider(string wkhtmltopdfRelativePath = "Rotativa")
             }
         }
 
-        /* <inheritDoc /> */
+        /** <inheritDoc /> */
         public string GetPath() => _rotativaLocation;
     }
 }

Wkhtmltopdf.NetCore/Configuration/RotativaPathAsPrefixPathProvider.cs

@@ -16,9 +16,9 @@ internal class RotativaPathAsPrefixPathProvider : IWkhtmltopdfPathProvider
         /* <inheritDoc /> */
         public string GetPath()
         {
-#pragma warning disable 612
+#pragma warning disable 618
             var wkhtmlPath = WkhtmltopdfConfiguration.RotativaPath;
-#pragma warning restore 612
+#pragma warning restore 618
 
             string rotativaLocation;
             if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))

Wkhtmltopdf.NetCore/Configuration/WkhtmltopdfConfiguration.cs

@@ -8,9 +8,14 @@
 
 namespace Wkhtmltopdf.NetCore
 {
+    /// <summary>
+    /// Extension methods for setting up Wkhtmltopdf.NetCore services.
+    /// </summary>
     public static class WkhtmltopdfConfiguration
     {
-        [Obsolete] public static string RotativaPath { get; set; }
+        [Obsolete("Use " + nameof(AddWkhtmltopdf) + " accepting " + nameof(IMvcBuilder)
+            + " with suitable " + nameof(IWkhtmltopdfPathProvider) + ".")]
+        public static string RotativaPath { get; set; }
 
         /// <summary>
         ///     Setup Rotativa library
@@ -20,7 +25,7 @@ public static class WkhtmltopdfConfiguration
         ///     Optional. Relative path to the directory containing wkhtmltopdf.
         ///     Default is "Rotativa". Download at https://wkhtmltopdf.org/downloads.html
         /// </param>
-        [Obsolete]
+        [Obsolete("Use " + nameof(AddWkhtmltopdf) + " accepting " + nameof(IMvcBuilder) + ".")]
         public static IServiceCollection AddWkhtmltopdf(this IServiceCollection services,
             string wkhtmltopdfRelativePath = "Rotativa")
         {

Wkhtmltopdf.NetCore/Implementation/Interfaces/IWkhtmlDriver.cs

@@ -2,6 +2,9 @@
 
 namespace Wkhtmltopdf.NetCore
 {
+    /// <summary>
+    /// Invokes the wkhtmltopdf.
+    /// </summary>
     public interface IWkhtmlDriver
     {
         /// <summary>

Wkhtmltopdf.NetCore/Implementation/WkhtmlDriver.cs

@@ -7,16 +7,22 @@
 
 namespace Wkhtmltopdf.NetCore
 {
+    /// <summary>
+    /// Invokes the wkhtmltopdf.
+    /// </summary>
     public class WkhtmlDriver : IWkhtmlDriver
     {
         private readonly IWkhtmltopdfPathProvider _pathProvider;
 
+        /// <summary>
+        /// Constructs new instance of <see cref="WkhtmlDriver"/>.
+        /// </summary>
         public WkhtmlDriver(IWkhtmltopdfPathProvider pathProvider = null)
         {
             _pathProvider = pathProvider ?? RotativaPathAsPrefixPathProvider.Default;
         }
 
-        /* <inheritDoc /> */
+        /** <inheritDoc /> */
         public byte[] Convert(IConvertOptions options, string html) => Convert(_pathProvider, options.GetConvertOptions(), html);
 
         /// <summary>
@@ -26,7 +32,7 @@ public WkhtmlDriver(IWkhtmltopdfPathProvider pathProvider = null)
         /// <param name="switches">Switches that will be passed to wkhtmltopdf binary.</param>
         /// <param name="html">String containing HTML code that should be converted to PDF.</param>
         /// <returns>PDF as byte array.</returns>
-        [Obsolete]
+        [Obsolete("Use injected " + nameof(IWkhtmlDriver) + ".")]
         public static byte[] Convert(string wkhtmlPath, string switches, string html)
         {
             string rotativaLocation;

Wkhtmltopdf.NetCore/WkhtmlDriverException.cs

@@ -2,9 +2,15 @@
 
 namespace Wkhtmltopdf.NetCore
 {
+    /// <summary>
+    /// Custom Wkhtmltopdf.NetCore exception.
+    /// </summary>
     [Serializable]
     public class WkhtmlDriverException : Exception
     {
+        /// <summary>
+        /// Constructs new instance of <see cref="WkhtmlDriverException"/>
+        /// </summary>
         public WkhtmlDriverException(string message, Exception e) : base(message, e)
         {
         }

Wkhtmltopdf.NetCore/Wkhtmltopdf.NetCore.csproj

@@ -5,6 +5,8 @@
     <AssemblyVersion>3.0.2.0</AssemblyVersion>
     <FileVersion>3.0.2.0</FileVersion>
     <Version>3.0.2</Version>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
     <Description>This project implements the library wkhtmltopdf for asp net core and a view engine, working in windows, macos, linux and docker.
 
 For more information about how to use it, go to https://github.com/fpanaccia/Wkhtmltopdf.NetCore.Example</Description>