editorconfig - Enable CA2247 to error on build (#4943)

* Docs - Fix some invalid XML doc tags * editorconfig - Enable CA2247
cefsharp · Sep 29, 2024 · 8aaa165 · 8aaa165
1 parent 17269dc
commit 8aaa165
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 13 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -156,3 +156,5 @@ csharp_space_between_square_brackets                                           =
 # Modifier order
 csharp_preferred_modifier_order                                                = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async : error
 
+# CA2247: Argument passed to TaskCompletionSource constructor should be TaskCreationOptions enum instead of TaskContinuationOptions enum
+dotnet_diagnostic.CA2247.severity = error
diff --git a/CefSharp.OffScreen/ChromiumWebBrowser.cs b/CefSharp.OffScreen/ChromiumWebBrowser.cs
@@ -905,7 +905,7 @@ protected virtual bool GetScreenPoint(int viewX, int viewY, out int screenX, out
             return RenderHandler?.GetScreenPoint(viewX, viewY, out screenX, out screenY) ?? false;
         }
 
-        /// </<inheritdoc/>
+        /// <inheritdoc/>
         void IRenderWebBrowser.OnAcceleratedPaint(PaintElementType type, Rect dirtyRect, AcceleratedPaintInfo acceleratedPaintInfo)
         {
             RenderHandler?.OnAcceleratedPaint(type, dirtyRect, acceleratedPaintInfo);

diff --git a/CefSharp.Wpf/ChromiumWebBrowser.cs b/CefSharp.Wpf/ChromiumWebBrowser.cs
@@ -981,7 +981,7 @@ void IRenderWebBrowser.OnAcceleratedPaint(PaintElementType type, Rect dirtyRect,
         /// client application. The contents of <paramref name="acceleratedPaintInfo"/>acceleratedPaintInfo
         /// will be released back to the pool after this callback returns.
         /// </summary>
-        /// <param name="type">indicates whether the element is the view or the popup widget.</param>
+        /// <param name="isPopup">indicates whether the element is the view or the popup widget.</param>
         /// <param name="dirtyRect">contains the set of rectangles in pixel coordinates that need to be repainted</param>
         /// <param name="acceleratedPaintInfo">contains the shared handle; on Windows it is a
         /// HANDLE to a texture that can be opened with D3D11 OpenSharedResource.</param>

diff --git a/CefSharp.Wpf/IRenderHandler.cs b/CefSharp.Wpf/IRenderHandler.cs
@@ -27,7 +27,7 @@ public interface IRenderHandler : IDisposable
         /// client application. The contents of <paramref name="acceleratedPaintInfo"/>acceleratedPaintInfo
         /// will be released back to the pool after this callback returns.
         /// </summary>
-        /// <param name="type">indicates whether the element is the view or the popup widget.</param>
+        /// <param name="isPopup">indicates whether the element is the view or the popup widget.</param>
         /// <param name="dirtyRect">contains the set of rectangles in pixel coordinates that need to be repainted</param>
         /// <param name="acceleratedPaintInfo">contains the shared handle; on Windows it is a
         /// HANDLE to a texture that can be opened with D3D11 OpenSharedResource.</param>

diff --git a/CefSharp.Wpf/Rendering/AbstractRenderHandler.cs b/CefSharp.Wpf/Rendering/AbstractRenderHandler.cs
@@ -98,7 +98,7 @@ protected void ReleaseMemoryMappedView(ref MemoryMappedFile mappedFile, ref Memo
             }
         }
 
-        /// </<inheritdoc/>
+        /// <inheritdoc/>
         public virtual void OnAcceleratedPaint(bool isPopup, Rect dirtyRect, AcceleratedPaintInfo acceleratedPaintInfo)
         {
             // NOT USED

diff --git a/CefSharp.Wpf/Rendering/AllocHGlobalWritableBitmapRenderHandler.cs b/CefSharp.Wpf/Rendering/AllocHGlobalWritableBitmapRenderHandler.cs
@@ -96,7 +96,7 @@ protected virtual void Dispose(bool disposing)
             }
         }
 
-        /// </<inheritdoc/>
+        /// <inheritdoc/>
         void IRenderHandler.OnAcceleratedPaint(bool isPopup, Rect dirtyRect, AcceleratedPaintInfo acceleratedPaintInfo)
         {
             //NOT USED

diff --git a/CefSharp.Wpf/Rendering/DirectWritableBitmapRenderHandler.cs b/CefSharp.Wpf/Rendering/DirectWritableBitmapRenderHandler.cs
@@ -42,19 +42,19 @@ public DirectWritableBitmapRenderHandler(double dpiX, double dpiY, bool invalida
             this.invalidateDirtyRect = invalidateDirtyRect;
         }
 
-        /// </<inheritdoc/>
+        /// <inheritdoc/>
         void IDisposable.Dispose()
         {
 
         }
 
-        /// </<inheritdoc/>
+        /// <inheritdoc/>
         void IRenderHandler.OnAcceleratedPaint(bool isPopup, Rect dirtyRect, AcceleratedPaintInfo acceleratedPaintInfo)
         {
             throw new NotImplementedException();
         }
 
-        /// </<inheritdoc/>
+        /// <inheritdoc/>
         void IRenderHandler.OnPaint(bool isPopup, Rect dirtyRect, IntPtr buffer, int width, int height, Image image)
         {
             var writeableBitmap = image.Source as WriteableBitmap;

diff --git a/CefSharp.Wpf/Rendering/Experimental/ByteArrayWritableBitmapRenderHandler.cs b/CefSharp.Wpf/Rendering/Experimental/ByteArrayWritableBitmapRenderHandler.cs
@@ -42,7 +42,7 @@ public ByteArrayWritableBitmapRenderHandler(double dpiX, double dpiY, bool inval
             this.dispatcherPriority = dispatcherPriority;
         }
 
-        /// </<inheritdoc/>
+        /// <inheritdoc/>
         void IRenderHandler.OnAcceleratedPaint(bool isPopup, Rect dirtyRect, AcceleratedPaintInfo acceleratedPaintInfo)
         {
             //NOT USED

diff --git a/CefSharp.Wpf/Rendering/Experimental/CompositionTargetRenderHandler.cs b/CefSharp.Wpf/Rendering/Experimental/CompositionTargetRenderHandler.cs
@@ -59,7 +59,7 @@ private void BrowserIsVisibleChanged(object sender, DependencyPropertyChangedEve
             }
         }
 
-        /// </<inheritdoc/>
+        /// <inheritdoc/>
         void IDisposable.Dispose()
         {
             CompositionTarget.Rendering -= OnRendering;
@@ -79,13 +79,13 @@ void IDisposable.Dispose()
             }
         }
 
-        /// </<inheritdoc/>
+        /// <inheritdoc/>
         void IRenderHandler.OnAcceleratedPaint(bool isPopup, Rect dirtyRect, AcceleratedPaintInfo acceleratedPaintInfo)
         {
             throw new NotImplementedException();
         }
 
-        /// </<inheritdoc/>
+        /// <inheritdoc/>
         void IRenderHandler.OnPaint(bool isPopup, Rect dirtyRect, IntPtr buffer, int width, int height, Image image)
         {
             if (image.Dispatcher.HasShutdownStarted)

diff --git a/CefSharp/IWindowInfo.cs b/CefSharp/IWindowInfo.cs
@@ -73,7 +73,7 @@ public interface IWindowInfo : IDisposable
 
         /// <summary>
         /// Optionally change the runtime style. Alloy style will always be used if
-        /// <see cref="WindowlessRenderingEnabled"> is true. See <see cref="CefRuntimeStyle"/>
+        /// <see cref="WindowlessRenderingEnabled"/> is true. See <see cref="CefRuntimeStyle"/>
         /// documentation for details.
         /// </summary>
         CefRuntimeStyle RuntimeStyle { get; set; }