ejball / XmlDocMarkdown

Generates Markdown from .NET XML documentation comments.
https://ejball.com/XmlDocMarkdown/
MIT License
102 stars 30 forks source link

Added C# 9 record handling #120

Closed bigtlb closed 3 years ago

bigtlb commented 3 years ago

C# 9 record type should work similar to class but it has some built in members and a specific inheritance, which may be better off hidden.

Suggested next steps is hide IEquatable<T> inheritance and builtin members.

image

ejball commented 3 years ago

Thanks for the contribution! I agree that hiding IEquatable<T> and the synthesized members makes sense, except for the public properties.

bigtlb commented 3 years ago

Please advise on how I can make the build succeed.

ejball commented 3 years ago

Looks like XML documentation comments didn't work correctly with records under 5.0.100. I've changed GitHub Actions to use the latest .NET 5 SDK; perhaps merging that in that will fix the PR build.

ejball commented 3 years ago

You should also run .\build.ps1 generate-docs and commit those changes.

bigtlb commented 3 years ago

Thanks. I was just noticing that part.

bigtlb commented 3 years ago

Should be good now. it build on my branch.

ejball commented 3 years ago

Rebased and amended: #121. Thanks again!