Skip to content

Add XML Comments#161

Merged
jfversluis merged 4 commits intomainfrom
Enforce-XML-Comments
Oct 20, 2021
Merged

Add XML Comments#161
jfversluis merged 4 commits intomainfrom
Enforce-XML-Comments

Conversation

@TheCodeTraveler
Copy link
Copy Markdown
Collaborator

@TheCodeTraveler TheCodeTraveler commented Oct 20, 2021

Mirrors CommunityToolkit.Maui.Markup PR: CommunityToolkit/Maui.Markup#13

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 .editorconfig file to the CommunityToolkit.Maui project (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

  • Adds Project-Specific .editorconfig to CommunityTooklit.Maui
    • Inherits from the root .editorconfig, by using root = false
    • Adds dotnet_diagnostic.CS1591.severity = error for only CommunityToolkit.Maui
      • Forces missing XML documentation to cause a build error
  • Adds <GenerateDocumentationFile>true</GenerateDocumentationFile> to CommunityToolkit.Maui.csproj
    • Ensures XML Documentation is required by the compiler
  • Adds missing XML Documentation
  • Converts MultiMathExpressionConverter.shared.cs to File-Scoped Namespace
  • Converts MathExpressionConverter.shared.cs to File-Scoped Namespace

@jfversluis jfversluis merged commit 5ab8d74 into main Oct 20, 2021
@delete-merged-branch delete-merged-branch bot deleted the Enforce-XML-Comments branch October 20, 2021 14:57
@github-actions github-actions bot locked and limited conversation to collaborators Nov 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants