Fix invalid characters in generated XML docs #607
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
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #607 +/- ##
==========================================
+ Coverage 95.10% 98.97% +3.87%
==========================================
Files 54 55 +1
Lines 2716 2639 -77
==========================================
+ Hits 2583 2612 +29
+ Misses 99 4 -95
+ Partials 34 23 -11
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
This resolves #605
This pull request introduces several changes aimed at improving XML documentation generation and ensuring that symbols in descriptions are properly escaped. Additionally, it includes updates to the project files to generate documentation files and adds new tests to verify these changes.
Improvements to XML documentation generation:
src/Refitter.Core/XmlDocumentationGenerator.cs: Added a new private methodEscapeSymbolsto properly escape<and>symbols in method summaries and remarks. UpdatedAppendMethodDocumentationto useEscapeSymbolsfor method summaries and remarks. [1] [2]Updates to project files:
src/Refitter.SourceGenerator/Refitter.SourceGenerator.csproj: Enabled the generation of documentation files by setting<GenerateDocumentationFile>true</GenerateDocumentationFile>.src/Refitter.Tests/Build/ProjectFileContents.cs: Enabled the generation of documentation files by setting<GenerateDocumentationFile>true</GenerateDocumentationFile>.New tests to verify changes:
src/Refitter.Tests/Examples/SymbolsInDescriptionTests.cs: Added a new test classSymbolsInDescriptionTestswith tests to ensure that symbols in descriptions are properly escaped and that the generated code can be built successfully.Additional minor changes:
src/Refitter.Core/Settings/RefitGeneratorSettings.cs: Added a missing closing tag in the XML documentation for theContractsNamespaceproperty.src/Refitter.SourceGenerator.Tests/CustomGenerated/CustomGenerated.cs: Updated XML documentation remarks to use escaped symbols for<and>. [1] [2]