Skip to content

Fix issues in MetadataAsSource XML documentation comment conversion#41119

Merged
sharwell merged 2 commits intodotnet:masterfrom
siegfriedpammer:mas-xmldoc-fixes
Jan 31, 2020
Merged

Fix issues in MetadataAsSource XML documentation comment conversion#41119
sharwell merged 2 commits intodotnet:masterfrom
siegfriedpammer:mas-xmldoc-fixes

Conversation

@siegfriedpammer
Copy link
Contributor

This fixes #39877

See #39877 (comment) for a detailed description.

TL;DR

  1. Only adds a comment above a member, if DocCommentConverter.ConvertDocCommentToRegularComment returns anything.
  2. Strips leading whitespace before checking whether a line starts with a single-line documentation comment (i.e. ///).

…rmed" XML comments contain superfluous /// markers for every line-break in the original comment.
@siegfriedpammer siegfriedpammer requested a review from a team as a code owner January 21, 2020 20:21
@sharwell
Copy link
Contributor

Wow, adding a test for this is way more difficult than I expected. I am hoping to get a baseline test completed shortly as part of #24188, and once that is merged we can update this pull request to show how it improves the situation.

@jinujoseph jinujoseph added Area-IDE Community The pull request was submitted by a contributor who is not a Microsoft employee. labels Jan 28, 2020
@sharwell
Copy link
Contributor

📝 I'm doing a manual validation for this so it can be merged sooner.

@siegfriedpammer
Copy link
Contributor Author

If there's anything I can help you with to get this done faster, please tell me.

@sharwell
Copy link
Contributor

Yeah this is a big improvement 👍

@sharwell sharwell merged commit 4981a98 into dotnet:master Jan 31, 2020
@sharwell sharwell added this to the 16.5.P3 milestone Jan 31, 2020
@siegfriedpammer siegfriedpammer deleted the mas-xmldoc-fixes branch January 31, 2020 23:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area-IDE Community The pull request was submitted by a contributor who is not a Microsoft employee.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Decompiled source includes an empty comment above each method

3 participants