Extend XML documentation on Facade APIs

[1nf0rmagician]

Is your feature request related to a problem? Please describe.
Developers struggle with using our facades in their applications. Eventhough the functions are described well, the parameters are not always self-explanatory. This causes unnecessary effort on our site to explain the usage of the facades and is difficult for newcommers to the project.

Describe the solution you'd like
Use parameter descriptions in xml comments which explain what they are used for in the function.

Additional context
A good example is the IWorkerSupport Interface, which requires an identifier to add an instruction, but specifies nowhere what this identifier is used for. In this case its the identifier of the VisualInstructor not of the instruction nor the source of the instruction which are both valid assumptions for the parameter as well.

[Toxantron]

Interesting example: The identifier for the facade is actually not the instructor (it could be, but makes little sense). It's intended as an additional way to display instructions independent from instructors. The module should also return those identifiers (sources) when there are any requests.

I guess this highlights just how important this issue and therefor better docs on our facades are.

[1nf0rmagician]

Does that mean that getting the Facade and adding an instruction with the identifier of the VisualInstructor resource is not the intended way of using the facade, but instead you would recommend to get the instructor from the ResourceManagement and using that to display or execute instructions?
The facade could then be used to add instructions from let's say a module which does not correspond to one VisualInstructor but uses its own identitfier for the method calls? 🤔