nasa / osal

The Core Flight System (cFS) Operating System Abstraction Layer (OSAL)
Apache License 2.0
557 stars 218 forks source link

OSAL ut_assert UT_SetHandlerFunction comments correction #1484

Open CDKnightNASA opened 2 weeks ago

CDKnightNASA commented 2 weeks ago

Describe the bug The documentation in the comments above UT_SetHandlerFunction() incorrectly describe the parameters as hook parameters.

https://github.com/nasa/osal/blob/a2011776dbfb24835a39b0b080ec574421f70ca6/ut_assert/inc/utstubs.h#L325

 * \param HandlerFunc User defined hook function.  Set NULL to delete/clear an entry.
 * \param UserObj  Arbitrary user data object to pass to the hook function

Also it would be nice to clarify--if I set hooks for a function and set a handler, are the hooks called, then the handler? It seems to be the case but would be nice to make explicit.

To Reproduce n/a

Expected behavior n/a

Code snips n/a

System observed on: n/a

Additional context n/a

Reporter Info Chris Knight Christopher.D.Knight@nasa.gov