Core - Code cleanup

- Make more classes sealed - Add xml doc - Add serializable constructor
shenlanchenwei · Feb 22, 2022 · 3d39238 · 3d39238
1 parent 597e54f
commit 3d39238
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 7 deletions.
diff --git a/CefSharp.Wpf/Handler/ContextMenuHandler.cs b/CefSharp.Wpf/Handler/ContextMenuHandler.cs
@@ -305,7 +305,7 @@ private static IList<MenuModel> GetMenuItems(IMenuModel model)
 
                 var subItems = model.GetSubMenuAt(i);
 
-                IList<MenuModel> subMenus = subItems == null ? null : GetMenuItems(subItems);
+                var subMenus = subItems == null ? null : GetMenuItems(subItems);
 
                 var menuItem = new MenuModel
                 {

diff --git a/CefSharp/Callback/TaskResolveCallback.cs b/CefSharp/Callback/TaskResolveCallback.cs
@@ -12,7 +12,7 @@ namespace CefSharp
     /// <summary>
     /// Provides a callback implementation of <see cref="IResolveCallback"/>.
     /// </summary>
-    public class TaskResolveCallback : IResolveCallback
+    public sealed class TaskResolveCallback : IResolveCallback
     {
         private readonly TaskCompletionSource<ResolveCallbackResult> taskCompletionSource;
         private volatile bool isDisposed;

diff --git a/CefSharp/Callback/TaskSetCookieCallback.cs b/CefSharp/Callback/TaskSetCookieCallback.cs
@@ -11,7 +11,7 @@ namespace CefSharp
     /// <summary>
     /// Provides a callback implementation of <see cref="ISetCookieCallback"/>.
     /// </summary>
-    public class TaskSetCookieCallback : ISetCookieCallback
+    public sealed class TaskSetCookieCallback : ISetCookieCallback
     {
         private readonly TaskCompletionSource<bool> taskCompletionSource;
         private volatile bool isDisposed;

diff --git a/CefSharp/DevTools/DevToolsClientException.cs b/CefSharp/DevTools/DevToolsClientException.cs
@@ -3,12 +3,14 @@
 // Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
 
 using System;
+using System.Runtime.Serialization;
 
 namespace CefSharp.DevTools
 {
     /// <summary>
     /// The exception that is thrown when there's a problem executing a DevTools protocol method.
     /// </summary>
+    [Serializable]
     public class DevToolsClientException : Exception
     {
         /// <summary>
@@ -54,5 +56,11 @@ public DevToolsClientException(string message, DevToolsDomainErrorResponse error
         public DevToolsClientException(string message, Exception inner) : base(message, inner)
         {
         }
+
+        /// <inheritdoc/>
+        protected DevToolsClientException(SerializationInfo serializationInfo, StreamingContext streamingContext) : base(serializationInfo, streamingContext)
+        {
+
+        }
     }
 }
diff --git a/CefSharp/Internals/InMemoryResourceRequestHandler.cs b/CefSharp/Internals/InMemoryResourceRequestHandler.cs
@@ -6,57 +6,74 @@
 
 namespace CefSharp.Internals
 {
-    public class InMemoryResourceRequestHandler : IResourceRequestHandler
+    /// <summary>
+    /// InMemoryResourceRequestHandler
+    /// </summary>
+    public sealed class InMemoryResourceRequestHandler : IResourceRequestHandler
     {
         private readonly byte[] data;
         private readonly string mimeType;
 
+        /// <summary>
+        /// Default constructor
+        /// </summary>
+        /// <param name="data">data</param>
+        /// <param name="mimeType">mime (content) type</param>
         public InMemoryResourceRequestHandler(byte[] data, string mimeType)
         {
             this.data = data;
             this.mimeType = mimeType;
         }
 
-        void IDisposable.Dispose()
+        /// <inheritdoc/>
+        public void Dispose()
         {
 
         }
 
+        /// <inheritdoc/>
         ICookieAccessFilter IResourceRequestHandler.GetCookieAccessFilter(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame, IRequest request)
         {
             return null;
         }
 
+        /// <inheritdoc/>
         IResourceHandler IResourceRequestHandler.GetResourceHandler(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame, IRequest request)
         {
             return ResourceHandler.FromByteArray(data, mimeType);
         }
 
+        /// <inheritdoc/>
         IResponseFilter IResourceRequestHandler.GetResourceResponseFilter(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame, IRequest request, IResponse response)
         {
             return null;
         }
 
+        /// <inheritdoc/>
         CefReturnValue IResourceRequestHandler.OnBeforeResourceLoad(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame, IRequest request, IRequestCallback callback)
         {
             return CefReturnValue.Continue;
         }
 
+        /// <inheritdoc/>
         bool IResourceRequestHandler.OnProtocolExecution(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame, IRequest request)
         {
             return false;
         }
 
+        /// <inheritdoc/>
         void IResourceRequestHandler.OnResourceLoadComplete(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame, IRequest request, IResponse response, UrlRequestStatus status, long receivedContentLength)
         {
 
         }
 
+        /// <inheritdoc/>
         void IResourceRequestHandler.OnResourceRedirect(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame, IRequest request, IResponse response, ref string newUrl)
         {
 
         }
 
+        /// <inheritdoc/>
         bool IResourceRequestHandler.OnResourceResponse(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame, IRequest request, IResponse response)
         {
             return false;

diff --git a/CefSharp/ResourceRequestHandlerFactory.cs b/CefSharp/ResourceRequestHandlerFactory.cs
@@ -58,8 +58,7 @@ public virtual bool RegisterHandler(string url, byte[] data, string mimeType = R
         /// <returns>returns true if successfully removed</returns>
         public virtual bool UnregisterHandler(string url)
         {
-            ResourceRequestHandlerFactoryItem entry;
-            return Handlers.TryRemove(url, out entry);
+            return Handlers.TryRemove(url, out _);
         }
 
         /// <summary>