Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc comments: fix validation issues in docs build #6744

Merged
merged 9 commits into from
Sep 7, 2021

Conversation

ghogen
Copy link
Contributor

@ghogen ghogen commented Aug 6, 2021

Fixes #6743

Context

The doc build is throwing some validation errors on some XML code comment constructs, such as invalid tags or improper nesting of tags.

Changes Made

Fix several XML comments

Testing

Notes

No change other than code comments

@ghogen ghogen changed the title Doc comments Doc comments: fix validation issues in docs build Aug 6, 2021
@ghogen
Copy link
Contributor Author

ghogen commented Aug 6, 2021

@gewarren Here are the changes in MSBuild for the doc validation issues.

src/Tasks/CreateItem.cs Outdated Show resolved Hide resolved
src/Tasks/MSBuild.cs Outdated Show resolved Hide resolved
src/Build/Definition/Project.cs Outdated Show resolved Hide resolved
ghogen and others added 2 commits September 7, 2021 10:22
@ghogen
Copy link
Contributor Author

ghogen commented Sep 7, 2021

@rainersigwald porting doc comment changes from this PR into MSBuild source:
dotnet/dotnet-api-docs#7082

@rainersigwald rainersigwald added the merge-when-branch-open PRs that are approved, except that there is a problem that means we are not merging stuff right now. label Sep 7, 2021
@rainersigwald rainersigwald merged commit 5e0b0ea into dotnet:main Sep 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-when-branch-open PRs that are approved, except that there is a problem that means we are not merging stuff right now.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc validation errors from XML comments
3 participants