search

modelsbuilder / ModelsBuilder.Original

The Community Models Builder for Umbraco
MIT License
114 stars 49 forks source link

Add XML comments to public members (resolves CS1591 warnings) #225

Open michaelchart opened 5 years ago

michaelchart commented 5 years ago

When XML documentation is enabled for the project (see screenshot below), the CS1591 compiler warning means that any public members of classes must have a documentation comment to prevent a warning.

image

There's currently no way to disable this documentation requirement for generated code so there seems to be no workaround for this issue - see https://github.com/dotnet/roslyn/issues/12702.

This PR adds <summary> comments to the previously uncommented public members of the generated models classes. An alternative approach could be to add #pragma warning disable 1591 comments around these members, but it seemed just as easy to add a simple documentation comment. Resolves #164

michaelchart commented 5 years ago

@zpqrtbnk Any thoughts on whether this PR is OK, and if it can be merged soon?

zpqrtbnk commented 5 years ago

Hey. Sorry for delay. PR is OK and will be merged somehow. But, as you may be aware, ModelsBuilder development is being reorganized at the moment. Will announce dates, eventually.