CS1591 is fired on source generated code

[chsienki]

On a project with the /doc: option enabled, the compiler will issue a warning on code that is coming from a generated file. (see dotnet/runtime#53275)

A user can suppress the issue via a .globalconfig, but has no other recourse to fix the issue. Should we not fire CS1591 for generated code, or is it still a useful indicator to the user that types in their public API are going to have no documentation?

[sharwell]

Related to #41171

[chsienki]

Note this still occurs if the file correctly marks itself as generated via any of the heuristic methods.

[Youssef1313]

I don't see why the compiler shouldn't issue the warning?

If the generated type is partial, then this could be a duplicate of #54103, and isn't specific to source generated files. Otherwise, then the compiler is correct about issuing a diagnostic IMO.

[Youssef1313]

@chsienki Can you check if #56419 resolves this?

[Youssef1313]

I see there are other aspects than what #56419 solves. (e.g: dotnet/runtime#61379). But I think generator authors should produce a #pragma warning disables or properly generate documentation comments.

Not much convinced the compiler should special case generated code here.

[jcouv]

This was also reported regarding [JsonSerializable] (in #60533). We should either have the source generator produce documentation, or do a compiler-level solution. Will chat offline

[nabond251]

FWIW, I'm one of those odd birds that makes the compiler treat warnings like errors. Admittedly bit of a hardline approach, but muh code quality. Such draconian practices are duly rewarded by this breaking build.

[mwasplund]

Can we get an answer as to whether this warning should respect *.generated.cs or <auto-generated />? I do not want generated code to pollute my build output with warnings. I do not have control over this code and therefore do not want style warnings like this XML warning to show up. As @nabond251 called out, this punishes folks that like to enforce code style using warnings as errors.