Skip to content

Enable CS1591 enforcement on projects with 100% doc coverage#33675

Merged
rmarinho merged 1 commit intomainfrom
docs/controls-core-enable-cs1591
Jan 22, 2026
Merged

Enable CS1591 enforcement on projects with 100% doc coverage#33675
rmarinho merged 1 commit intomainfrom
docs/controls-core-enable-cs1591

Conversation

@jfversluis
Copy link
Member

Note

Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!

Description

Enables CS1591 (missing XML documentation) as a warning-as-error on all projects that already have 100% API documentation coverage. This prevents future documentation gaps from being introduced.

Projects Updated

Project Change
Microsoft.Maui.Controls Added WarningsAsErrors: CS1591
Microsoft.Maui.Controls.Compatibility Moved CS1591 from NoWarn to WarningsAsErrors
Microsoft.AspNetCore.Components.WebView.Maui Added WarningsAsErrors: CS1591
Microsoft.AspNetCore.Components.WebView.WindowsForms Added WarningsAsErrors: CS1591
Microsoft.AspNetCore.Components.WebView.Wpf Added WarningsAsErrors: CS1591

Verification

All 5 projects were built and verified to have 0 CS1591 errors before enabling enforcement.

Stats

  • 5 files changed
  • +6/-1 lines

- Controls.Core: Add WarningsAsErrors CS1591
- Compatibility: Remove CS1591 from NoWarn, add to WarningsAsErrors
- BlazorWebView.Maui: Add WarningsAsErrors CS1591
- BlazorWebView.WindowsForms: Add WarningsAsErrors CS1591
- BlazorWebView.Wpf: Add WarningsAsErrors CS1591

All projects verified to build with 0 CS1591 errors.
Copilot AI review requested due to automatic review settings January 22, 2026 15:19
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR enables CS1591 (missing XML documentation warnings) as errors on 5 projects that already have 100% API documentation coverage, preventing future documentation regressions.

Changes:

  • Added CS1591 to WarningsAsErrors for 4 projects (Controls.Core, Wpf, WindowsForms, Maui BlazorWebView)
  • Moved CS1591 from NoWarn to WarningsAsErrors for Compatibility project

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
Controls.Core.csproj Added WarningsAsErrors property with CS1591 enforcement
Compatibility.csproj Removed CS1591 from NoWarn and added to WarningsAsErrors
Microsoft.AspNetCore.Components.WebView.Wpf.csproj Added WarningsAsErrors property with CS1591 enforcement
Microsoft.AspNetCore.Components.WebView.WindowsForms.csproj Added WarningsAsErrors property with CS1591 enforcement
Microsoft.AspNetCore.Components.WebView.Maui.csproj Added WarningsAsErrors property with CS1591 enforcement

@jfversluis jfversluis added this to the .NET 10.0 SR4 milestone Jan 22, 2026
@jfversluis jfversluis added the area-docs Conceptual docs, API docs, Samples label Jan 22, 2026
@rmarinho rmarinho merged commit b7cda8d into main Jan 22, 2026
34 checks passed
@rmarinho rmarinho deleted the docs/controls-core-enable-cs1591 branch January 22, 2026 19:11
@github-actions github-actions bot locked and limited conversation to collaborators Feb 22, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-docs Conceptual docs, API docs, Samples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants