The description of a method (procedure or function) should be formatted correctly to help programmers use the functionality correctly.
The function description must contain a description of the return value in the block of the same name. You must provide a description for all possible return types.
Diagnostics detects typical errors:
- No return value description
- Return value description for procedure
- Poor description of the return value: when the type name is present in the description, but its description is not specified
- To activate this more stringent check, you must turn off the short form permission by the diagnostic parameter