Inline documentation on OSAL routines is incorrect/outdated in many places #17
Description
Describe the bug
The comments in the function headers of many of the OSAL calls have become outdated and incorrect.
To Reproduce
N/A. This reflects source code comments only. Most evident on the "implementation" files which copied the comment block from the external function call.
Expected behavior
Comment blocks should better reflect reality of what the code does. The "real" comment block that describes the function should reside with the function prototype. The definition should also have a comment block but primarily for visual differentiation in the source code. This block should not re-describe the function, as this results in multiple copies of the same description and thus could become stale/divergent again.
Reporter Info
Joseph Hickey, Vantage Systems, Inc.