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

Enable xml doc comments for our client libraries #6869

Merged
merged 1 commit into from
Jul 10, 2019

Conversation

weshaggard
Copy link
Member

As part of enabling this a number of xml doc comments needed to be fixed or
warnings temporarily disabled to get a clean build. Follow-up issues will
be filed for each class of warnings that needed to be disabled.

PTAL @AlexGhiondea @chidozieononiwu @tg-msft @pakrym

@weshaggard
Copy link
Member Author

I've filed #6871 and #6870 as follow-up issues to fix some of the doc comment issues I didn't address in this PR. With this PR I fixed a lot of trivial issues but my main goal was to get the xml doc files generating.

@weshaggard
Copy link
Member Author

I filed a couple more issues #6873 and #6872

Copy link
Contributor

@pakrym pakrym left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tg-msft
Copy link
Member

tg-msft commented Jul 10, 2019

Manually editing the generated code is not ideal. Can we just exclude /Generated/*RestClient.cs for now? All of that's going to be blown over the next time we need to make any change.

As part of enabling this a number of xml doc comments needed to be fixed or
warnings temporarily disabled to get a clean build. Follow-up issues will
be filed for each class of warnings that needed to be disabled.
@weshaggard weshaggard force-pushed the EnableXmlDocComments branch from 441e0cc to 4d2c06b Compare July 10, 2019 23:03
@weshaggard
Copy link
Member Author

weshaggard commented Jul 10, 2019

Manually editing the generated code is not ideal. Can we just exclude /Generated/*RestClient.cs for now? All of that's going to be blown over the next time we need to make any change.

I don't know of any good way to skip those files as they generate errors and not warnings as most of them are invalid xml. The only option would be to disable xml doc generation completely which means no docs at all for those libraries.

@tg-msft
Copy link
Member

tg-msft commented Jul 10, 2019

Alright, I'll front load that work. Heads up @pakrym that you'll need to avoid any of your renames requiring generator changes until I get this addressed.

@weshaggard weshaggard merged commit c0511db into Azure:master Jul 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants