Generate XML documentation#206
Conversation
|
Is there a particular motivation to activate the documentation? I mean most classes do not have a single documentation on it, I wonder which benefit this brings us beyond a longer build time? I love what you do here, but if we do it, we have to first create meaningful class-level documentation before we start adding a file which bring zero benefits. I personally always prefer the library to be self-explaining and provide good markdown tutorials. That is also the reason why the README looks like it does. Do you want to contribute a full class-level documentation? |
|
The benefit that I can see, is that we could at least provide some documentation for anything that is already documented. There is already some relevant documentation (e.g. |
|
Okay, then let us do this. |
I noticed, that there is no XML documentation in the NuGet packages.
I'm adding it globally (in the
Directory.Build.props) and disable warnings about missing XML comments for public types or members (CS1591).#205 non-breaking