Improved inline xml documentation #383

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.

Sign up for GitHub

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

Jump to bottom

Merged

chkuang-g merged 1 commit into googlesamples:master from Si1ver:better-xml-docs

Sep 9, 2020

Contributor

Si1ver commented Jun 16, 2020 •

edited

Loading

Inline code documentation in C# files needs some love.

This PR improves:

Ensure xml tags are always correctly closed
Replace return tags with returns tags
Fix outdated argument names in inline documentation
Remove docs for removed arguments
Add docs for some undocumented arguments
Fix inline documentation to always starts with exactly three slashes ///
Fix regular comments to always starts with // and never with ///
Replace < in xmldoc with <
Fix missing quotes around values of xml attributes
Ensure <para> tag is inside another tag
Fix documentation on some enumeration values
Fix few typos


          Improved inline xml documentation.

0a0d5e7

chkuang-g merged commit bfc12dc into googlesamples:master

googlesamples locked and limited conversation to collaborators

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet