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

No XML comments on generated methods leads to build failures #104

Closed
TomasMorton opened this issue Jan 21, 2022 · 2 comments · Fixed by #105
Closed

No XML comments on generated methods leads to build failures #104

TomasMorton opened this issue Jan 21, 2022 · 2 comments · Fixed by #105

Comments

@TomasMorton
Copy link

TomasMorton commented Jan 21, 2022

I'm using the Source Generator, but when I add the [GenerateOneOf] attribute to a project that requires XML comments, it fails with:

Error CS1591 : Missing XML comment for publicly visible type or member 'Type.explicit operator InternalServiceError(Type)'
Error CS1591 : Missing XML comment for publicly visible type or member 'GenerateOneOfAttribute'

I've tried:

  • Adding generated_code = true to editor config,
  • Adding #pragma disable in the declaration of the OneOf,
  • Using assembly: SuppressMessage

Is it possible to:

  • Add the missing XML comments, or
  • Add a pragma disable, or
  • Make the methods internal (likely not, but it's an option!), or
  • Something else from the analyzer world to help out?
@romfir
Copy link
Contributor

romfir commented Jan 29, 2022

I will add #pragma warning disable 1591 to generated files, FYI the same issue exists with System.Text.Json source generator, I've reported an issue there: dotnet/runtime#64499

@TomasMorton
Copy link
Author

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants