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

When XML doc generation is off, namespaces used by crefs are treated as unused #4034

Closed
davkean opened this issue Jul 21, 2015 · 5 comments
Closed
Labels
Area-Compilers Resolution-Duplicate The described behavior is tracked in another issue
Milestone

Comments

@davkean
Copy link
Member

davkean commented Jul 21, 2015

When XML doc generation is off, namespaces used by crefs are greyed out indicating that are they are unused:
image

I'm also offered to remove using System despite it actually being used by the cref.

I'm not sure if this by design or not (or rather a fallout of how this was designed), but this seems incorrect, especially as the colorizer appears to be processing them (if we're not processing them, why we run the colorizer over them?).

@gafter
Copy link
Member

gafter commented Jul 21, 2015

We should probably disable reporting unused usings when we are not processing doc comments.

@sharwell
Copy link
Member

Duplicate of #2773.

Do note that this refactoring will cause a compile error once you switch to a configuration that generates XML docs (which is typically what you do in a release build).

@gafter gafter added the Resolution-Duplicate The described behavior is tracked in another issue label Jul 31, 2015
@gafter gafter closed this as completed Jul 31, 2015
@jnm2
Copy link
Contributor

jnm2 commented Dec 30, 2016

If removing the using breaks a cref, it should not be suggested. Please fix.

Currently this results in bouncing back and forth between ReSharper complaining that you should add the using for the XML documentation and Roslyn complaining that you should remove it. It's a bad user experience.

If the only correct solution is truly to enable XML doc generation, then please stop suggesting removal of the using and start suggesting enabling XML documentation output.

This may be a moonshot, but in an ideal world, I think I should be able to leave XML documentation output off and still have all the syntax checking as though it was on, minus the warning about publicly visible types missing comments.

@gafter
Copy link
Member

gafter commented Jan 1, 2017

@jnm2 discussion has moved to #2773

@jnm2
Copy link
Contributor

jnm2 commented Jan 1, 2017

@gafter Thanks. Moved the comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Compilers Resolution-Duplicate The described behavior is tracked in another issue
Projects
None yet
Development

No branches or pull requests

4 participants