Add missing docs to public methods and Markdown files (OSOE-153)

[Piedone]

• Go through all the C# files and add docs to all public methods missing them.
• Go through all the Markdown docs and add notes on all missing classes that consumers directly interface with (i.e. not for every class, internal helpers or other types are not needed).

Jira issue

[porgabi]

Go through all the C# files and add docs to all public methods missing them.

There are cases where the documentation already exists but not locally. For example, JsonModelBinder's BindModelAsync() has external documentation in IModelBinder, and it's already accessible (via on-hover tooltip or navigating to interface) without it being added locally as well:

Local implementation:

External interface documentation:

In such cases, is there still a need to add documentation to the local files as well?

[Piedone]

For methods implementing interfaces like this you don't need to add docs, since yes, they actually exist, even if not necessarily right there. If you want to extend on that, you can use <inheritdoc> to include the original docs, and add your own.

[porgabi]

In the existing documentation, there are cases where the parameters are also explicitly documented, and there are cases where they are not (only summaries are provided). In the newly added cases, should documentation
A) always be limited to summaries,
B) always include summaries and parameters, or
C) always include summaries but include parameters only when the parameters are not self-explanatory?

[Piedone]

C, and this is especially the case for extension methods, where even if you document parameters, you don't have to do that for the this one since that's trivial.