search

dotmake-build / command-line

Declarative syntax for System.CommandLine via attributes for easy, fast, strongly-typed (no reflection) usage. Includes a source generator which automagically converts your classes to CLI commands and properties to CLI options or CLI arguments.
https://dotmake.build
MIT License
81 stars 6 forks source link

Generated code triggers CS1591 when generating documentation file is turned on #6

Closed PatrickBig closed 10 months ago

PatrickBig commented 10 months ago

The generated files Eg: MyCommandBuilder-hiuadwahu.g.cs will generate the warning CS1591 when the project has the GenerateDocumentationFile property set to true.

There is a tag in the header of these files <auto-generated />, but this only helps in some scenarios like StyleCop.

Consider adding #pragma warning disable CS1591 to each generated file as well to prevent this.

calacayir commented 10 months ago

Good catch, thanks for reporting. This is now fixed with v1.6.4.

PatrickBig commented 10 months ago

Adding documentation is even better than ignoring the warning. Good fix :)