Merged
Conversation
jfversluis
approved these changes
Oct 20, 2021
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes
Fixes missing XML Comments
Description
This PR adds missing XML documentation and ensures that missing XML documentation will generate a build error going forward.
Adding an
.editorconfigfile to theCommunityToolkit.Mauiproject (which inherits from the root. editorconfig), it causes the compiler to throw a build error when XML Documentation is missing.This ensures that future PRs with new public APIs will include XML documentation.
Detailed Solution
.editorconfigtoCommunityTooklit.Maui.editorconfig, by usingroot = falsedotnet_diagnostic.CS1591.severity = errorfor onlyCommunityToolkit.Maui<GenerateDocumentationFile>true</GenerateDocumentationFile>toCommunityToolkit.Maui.csprojMultiMathExpressionConverter.shared.csto File-Scoped Namespace.editorconfigMathExpressionConverter.shared.csto File-Scoped Namespace.editorconfig