Enable GenerateDocumentationFile #6000
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zivkan
previously approved these changes
Sep 4, 2024
zivkan
previously approved these changes
Sep 6, 2024
Co-authored-by: Andy Zivkovic <zivkan@users.noreply.github.com>
zivkan
approved these changes
Sep 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bug
Fixes: https://github.com/NuGet/Client.Engineering/issues/2845
Description
In order to enforce certain style rules we need to enable GenerateDocumentationFile for all projects. This is a known issue, dotnet/roslyn#41640. The code we had for enabling GenerateDocumentationFile was not working because the value was being set by C# template. This now enables GenerateDocumentationFile for all projects. It also sets "WarningsNotAsErrors" for XML style errors for projects which are not shipped. CoPilot was used to generate documentation for some classes.
This also fixes errors that come up from enabling GenerateDocumentationFile. For using statements that need to be behind a conditional compilation, I grouped them together and placed them after the other using statements.
PR Checklist
Added testsLink to an issue or pull request to update docs if this PR changes settings, environment variables, new feature, etc.