Enable rule SA1648 (#2057)

* Enable rule SA1648

* Fix errors

* Fix error

* Add full stop to the documentation.

Author: akshay-zz

lib/PuppeteerSharp.ruleset

@@ -37,7 +37,7 @@
     <Rule Id="SA1518" Action="None" /> <!-- Error SA1518: File is required to end with a single newline character (SA1518)-->
     <Rule Id="SA1012" Action="Error" /> <!-- Error SA1012: Opening brace should be followed by a space. (SA1012) -->
     <Rule Id="SA1512" Action="Error" /> <!-- Error SA1502: Element should not be on a single line (SA1502) -->
-    <Rule Id="SA1648" Action="None" /> <!-- Error SA1648: inheritdoc should be used with inheriting class (SA1648) -->
+    <Rule Id="SA1648" Action="Error" /> <!-- Error SA1648: inheritdoc should be used with inheriting class (SA1648) -->
     <Rule Id="SA1616" Action="Error" /> <!-- Error SA1616: Element return value documentation should have text (SA1616)-->
     <Rule Id="SA1627" Action="Error" /> <!-- Error SA1627: The documentation text within the \'exception\' tag should not be empty. (SA1627)-->
     <Rule Id="SA1643" Action="Error" /> <!-- Error SA1643: Destructor summary documentation should begin with standard text (SA1643) -->

lib/PuppeteerSharp/Browser.cs

@@ -241,7 +241,6 @@ internal static async Task<Browser> CreateAsync(
             return browser;
         }
 
-        /// <inheritdoc/>
         internal IEnumerable<string> GetCustomQueryHandlerNames()
             => CustomQueriesManager.GetCustomQueryHandlerNames();
 

lib/PuppeteerSharp/BrowserContext.cs

@@ -33,7 +33,7 @@ internal BrowserContext(Connection connection, Browser browser, string contextId
         /// <inheritdoc/>
         public bool IsIncognito => Id != null;
 
-        /// <inheritdoc/>
+        /// <inheritdoc cref="Browser"/>
         public Browser Browser { get; }
 
         /// <inheritdoc/>

lib/PuppeteerSharp/BrowserFetcher.cs

@@ -20,7 +20,9 @@ namespace PuppeteerSharp
     /// <inheritdoc/>
     public class BrowserFetcher : IBrowserFetcher
     {
-        /// <inheritdoc/>
+        /// <summary>
+        /// Default chromium revision.
+        /// </summary>
         public const string DefaultChromiumRevision = "970485";
 
         private static readonly Dictionary<Product, string> _hosts = new Dictionary<Product, string>
@@ -45,7 +47,7 @@ public class BrowserFetcher : IBrowserFetcher
         private readonly CustomFileDownloadAction _customFileDownload;
         private bool _isDisposed;
 
-        /// <inheritdoc/>
+        /// <inheritdoc cref="BrowserFetcher"/>
         public BrowserFetcher()
         {
             DownloadsFolder = Path.Combine(GetExecutablePath(), ".local-chromium");
@@ -55,12 +57,12 @@ public BrowserFetcher()
             _customFileDownload = _webClient.DownloadFileTaskAsync;
         }
 
-        /// <inheritdoc/>
+        /// <inheritdoc cref="BrowserFetcher"/>
         public BrowserFetcher(Product product) : this(new BrowserFetcherOptions { Product = product })
         {
         }
 
-        /// <inheritdoc/>
+        /// <inheritdoc cref="BrowserFetcher"/>
         public BrowserFetcher(BrowserFetcherOptions options)
         {
             if (options == null)
@@ -102,7 +104,15 @@ public IWebProxy WebProxy
             set => _webClient.Proxy = value;
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Get executable path.
+        /// </summary>
+        /// <param name="product"><see cref="Product"/>.</param>
+        /// <param name="platform"><see cref="Platform"/>.</param>
+        /// <param name="revision">chromium revision.</param>
+        /// <param name="folderPath">folder path.</param>
+        /// <returns>executable path.</returns>
+        /// <exception cref="ArgumentException">For not supported <see cref="Platform"/>.</exception>
         public static string GetExecutablePath(Product product, Platform platform, string revision, string folderPath)
         {
             if (product == Product.Chrome)
@@ -347,7 +357,10 @@ internal static string GetExecutablePath()
             return assemblyDirectory.FullName;
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Dispose <see cref="WebClient"/>.
+        /// </summary>
+        /// <param name="disposing">Indicates whether disposal was initiated by <see cref="Dispose()"/> operation.</param>
         protected virtual void Dispose(bool disposing)
         {
             if (_isDisposed)

lib/PuppeteerSharp/CDPSession.cs

@@ -46,7 +46,7 @@ internal CDPSession(Connection connection, TargetType targetType, string session
         /// <inheritdoc/>
         public ILoggerFactory LoggerFactory => Connection.LoggerFactory;
 
-        /// <inheritdoc/>
+        /// <inheritdoc cref="Connection"/>
         internal Connection Connection { get; private set; }
 
         /// <inheritdoc/>

lib/PuppeteerSharp/ConsoleMessageLocation.cs

@@ -23,11 +23,17 @@ public class ConsoleMessageLocation : IEquatable<ConsoleMessageLocation>
         /// </summary>
         public int? ColumnNumber { get; set; }
 
-        /// <inheritdoc/>
+        /// <summary>Overriding == operator for <see cref="ConsoleMessageLocation"/>.</summary>
+        /// <param name="location1">the value to compare against <paramref name="location2" />.</param>
+        /// <param name="location2">the value to compare against <paramref name="location1" />.</param>
+        /// <returns><c>true</c> if the two instances are equal to the same value.</returns>
         public static bool operator ==(ConsoleMessageLocation location1, ConsoleMessageLocation location2)
             => EqualityComparer<ConsoleMessageLocation>.Default.Equals(location1, location2);
 
-        /// <inheritdoc/>
+        /// <summary>Overriding != operator for <see cref="ConsoleMessageLocation"/>.</summary>
+        /// <param name="location1">the value to compare against <paramref name="location2" />.</param>
+        /// <param name="location2">the value to compare against <paramref name="location1" />.</param>
+        /// <returns><c>true</c> if the two instances are not equal to the same value.</returns>
         public static bool operator !=(ConsoleMessageLocation location1, ConsoleMessageLocation location2)
             => !(location1 == location2);
 

lib/PuppeteerSharp/ElementHandle.cs

@@ -546,7 +546,11 @@ public async Task<BoxModelPoint> ClickablePointAsync(Offset? offset = null)
             };
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Scroll into view if needed.
+        /// </summary>
+        /// <returns><see cref="Task"/>.</returns>
+        /// <exception cref="PuppeteerException">Puppeteer exception.</exception>
         public async Task ScrollIntoViewIfNeededAsync()
         {
             var errorMessage = await EvaluateFunctionAsync<string>(

lib/PuppeteerSharp/Input/Mouse.cs

@@ -13,7 +13,7 @@ public class Mouse : IMouse
         private decimal _y = 0;
         private MouseButton _button = MouseButton.None;
 
-        /// <inheritdoc/>
+        /// <inheritdoc cref="Mouse"/>
         public Mouse(CDPSession client, Keyboard keyboard)
         {
             _client = client;

lib/PuppeteerSharp/Input/Touchscreen.cs

@@ -10,7 +10,7 @@ public class Touchscreen : ITouchscreen
         private readonly CDPSession _client;
         private readonly Keyboard _keyboard;
 
-        /// <inheritdoc/>
+        /// <inheritdoc cref="Touchscreen"/>
         public Touchscreen(CDPSession client, Keyboard keyboard)
         {
             _client = client;

lib/PuppeteerSharp/JSHandle.cs

@@ -21,7 +21,7 @@ internal JSHandle(ExecutionContext context, CDPSession client, RemoteObject remo
             RemoteObject = remoteObject;
         }
 
-        /// <inheritdoc/>
+        /// <inheritdoc cref="ExecutionContext"/>
         public ExecutionContext ExecutionContext { get; }
 
         /// <inheritdoc/>