AdamsLair / duality

a 2D Game Development Framework
https://adamslair.github.io/duality
MIT License
1.4k stars 291 forks source link

Fix xml doc warnings #804

Closed Barsonax closed 4 years ago

Barsonax commented 4 years ago

Summary

I have noticed there are thousands of warnings in duality due to things like misformed xml documentation. For instance xml documentation where to parameters do not match the methid parameters. Consider fixing this as it really clutters the warning dialog and might lead to wrong documentation.

I noticed the following warnings:

ilexp commented 4 years ago

I think most of those were ignored before - this was probably introduced due to the SDK project style change, see here for the previous warning setup for reference.

At least CS1591 and CS0419 can be safely ignored with no harm done, depends for the others. Not suddenly drowning in docs warnings, causing people to miss other, more important warnings, should be a priority though.

Barsonax commented 4 years ago

Ah they were defined in the csproj itself? Missed that when doing the migration.. I think its better to move these to the Directory.Build.props file though. I will add CS0419 as well.