gapic-generator-csharp icon indicating copy to clipboard operation
gapic-generator-csharp copied to clipboard

Published 20 hours ago • verified publisher icon googleapis

Fail generation if any protos have missing comments

Open jskeet opened this issue 1 year ago • 1 comments

Currently, if any protobuf element is missing a comment, we generate code but the result doesn't compile. The missing comments could be on messages, RPCs, services, fields, enums, enum values - anything, basically.

It would be helpful for the generator to fail for this:

  • We would highlight the problem to API producers earlier
  • We can provide an error message with the complete list of elements missing comments, rather than having to look through protos after finding C# compilation errors

jskeet avatar Aug 03 '23 09:08 jskeet

protoc generates code that ignores CS1591, so this actually only causes a later failure on GAPIC-generated elements. A warning for other elements would still be handy though. (And having prototyped this, there are a lot of them....)

jskeet avatar Apr 23 '24 09:04 jskeet