Skip to content

Commit 8aaa165

Browse files
authored
editorconfig - Enable CA2247 to error on build (#4943)
* Docs - Fix some invalid XML doc tags * editorconfig - Enable CA2247
1 parent 17269dc commit 8aaa165

10 files changed

+15
-13
lines changed

.editorconfig

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,3 +156,5 @@ csharp_space_between_square_brackets =
156156
# Modifier order
157157
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async : error
158158

159+
# CA2247: Argument passed to TaskCompletionSource constructor should be TaskCreationOptions enum instead of TaskContinuationOptions enum
160+
dotnet_diagnostic.CA2247.severity = error

CefSharp.OffScreen/ChromiumWebBrowser.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -905,7 +905,7 @@ protected virtual bool GetScreenPoint(int viewX, int viewY, out int screenX, out
905905
return RenderHandler?.GetScreenPoint(viewX, viewY, out screenX, out screenY) ?? false;
906906
}
907907

908-
/// </<inheritdoc/>
908+
/// <inheritdoc/>
909909
void IRenderWebBrowser.OnAcceleratedPaint(PaintElementType type, Rect dirtyRect, AcceleratedPaintInfo acceleratedPaintInfo)
910910
{
911911
RenderHandler?.OnAcceleratedPaint(type, dirtyRect, acceleratedPaintInfo);

CefSharp.Wpf/ChromiumWebBrowser.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -981,7 +981,7 @@ void IRenderWebBrowser.OnAcceleratedPaint(PaintElementType type, Rect dirtyRect,
981981
/// client application. The contents of <paramref name="acceleratedPaintInfo"/>acceleratedPaintInfo
982982
/// will be released back to the pool after this callback returns.
983983
/// </summary>
984-
/// <param name="type">indicates whether the element is the view or the popup widget.</param>
984+
/// <param name="isPopup">indicates whether the element is the view or the popup widget.</param>
985985
/// <param name="dirtyRect">contains the set of rectangles in pixel coordinates that need to be repainted</param>
986986
/// <param name="acceleratedPaintInfo">contains the shared handle; on Windows it is a
987987
/// HANDLE to a texture that can be opened with D3D11 OpenSharedResource.</param>

CefSharp.Wpf/IRenderHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public interface IRenderHandler : IDisposable
2727
/// client application. The contents of <paramref name="acceleratedPaintInfo"/>acceleratedPaintInfo
2828
/// will be released back to the pool after this callback returns.
2929
/// </summary>
30-
/// <param name="type">indicates whether the element is the view or the popup widget.</param>
30+
/// <param name="isPopup">indicates whether the element is the view or the popup widget.</param>
3131
/// <param name="dirtyRect">contains the set of rectangles in pixel coordinates that need to be repainted</param>
3232
/// <param name="acceleratedPaintInfo">contains the shared handle; on Windows it is a
3333
/// HANDLE to a texture that can be opened with D3D11 OpenSharedResource.</param>

CefSharp.Wpf/Rendering/AbstractRenderHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ protected void ReleaseMemoryMappedView(ref MemoryMappedFile mappedFile, ref Memo
9898
}
9999
}
100100

101-
/// </<inheritdoc/>
101+
/// <inheritdoc/>
102102
public virtual void OnAcceleratedPaint(bool isPopup, Rect dirtyRect, AcceleratedPaintInfo acceleratedPaintInfo)
103103
{
104104
// NOT USED

CefSharp.Wpf/Rendering/AllocHGlobalWritableBitmapRenderHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ protected virtual void Dispose(bool disposing)
9696
}
9797
}
9898

99-
/// </<inheritdoc/>
99+
/// <inheritdoc/>
100100
void IRenderHandler.OnAcceleratedPaint(bool isPopup, Rect dirtyRect, AcceleratedPaintInfo acceleratedPaintInfo)
101101
{
102102
//NOT USED

CefSharp.Wpf/Rendering/DirectWritableBitmapRenderHandler.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@ public DirectWritableBitmapRenderHandler(double dpiX, double dpiY, bool invalida
4242
this.invalidateDirtyRect = invalidateDirtyRect;
4343
}
4444

45-
/// </<inheritdoc/>
45+
/// <inheritdoc/>
4646
void IDisposable.Dispose()
4747
{
4848

4949
}
5050

51-
/// </<inheritdoc/>
51+
/// <inheritdoc/>
5252
void IRenderHandler.OnAcceleratedPaint(bool isPopup, Rect dirtyRect, AcceleratedPaintInfo acceleratedPaintInfo)
5353
{
5454
throw new NotImplementedException();
5555
}
5656

57-
/// </<inheritdoc/>
57+
/// <inheritdoc/>
5858
void IRenderHandler.OnPaint(bool isPopup, Rect dirtyRect, IntPtr buffer, int width, int height, Image image)
5959
{
6060
var writeableBitmap = image.Source as WriteableBitmap;

CefSharp.Wpf/Rendering/Experimental/ByteArrayWritableBitmapRenderHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public ByteArrayWritableBitmapRenderHandler(double dpiX, double dpiY, bool inval
4242
this.dispatcherPriority = dispatcherPriority;
4343
}
4444

45-
/// </<inheritdoc/>
45+
/// <inheritdoc/>
4646
void IRenderHandler.OnAcceleratedPaint(bool isPopup, Rect dirtyRect, AcceleratedPaintInfo acceleratedPaintInfo)
4747
{
4848
//NOT USED

CefSharp.Wpf/Rendering/Experimental/CompositionTargetRenderHandler.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ private void BrowserIsVisibleChanged(object sender, DependencyPropertyChangedEve
5959
}
6060
}
6161

62-
/// </<inheritdoc/>
62+
/// <inheritdoc/>
6363
void IDisposable.Dispose()
6464
{
6565
CompositionTarget.Rendering -= OnRendering;
@@ -79,13 +79,13 @@ void IDisposable.Dispose()
7979
}
8080
}
8181

82-
/// </<inheritdoc/>
82+
/// <inheritdoc/>
8383
void IRenderHandler.OnAcceleratedPaint(bool isPopup, Rect dirtyRect, AcceleratedPaintInfo acceleratedPaintInfo)
8484
{
8585
throw new NotImplementedException();
8686
}
8787

88-
/// </<inheritdoc/>
88+
/// <inheritdoc/>
8989
void IRenderHandler.OnPaint(bool isPopup, Rect dirtyRect, IntPtr buffer, int width, int height, Image image)
9090
{
9191
if (image.Dispatcher.HasShutdownStarted)

CefSharp/IWindowInfo.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public interface IWindowInfo : IDisposable
7373

7474
/// <summary>
7575
/// Optionally change the runtime style. Alloy style will always be used if
76-
/// <see cref="WindowlessRenderingEnabled"> is true. See <see cref="CefRuntimeStyle"/>
76+
/// <see cref="WindowlessRenderingEnabled"/> is true. See <see cref="CefRuntimeStyle"/>
7777
/// documentation for details.
7878
/// </summary>
7979
CefRuntimeStyle RuntimeStyle { get; set; }

0 commit comments

Comments
 (0)