Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OSAL ut_assert UT_SetHandlerFunction comments correction #1484

Open
CDKnightNASA opened this issue Nov 12, 2024 · 0 comments
Open

OSAL ut_assert UT_SetHandlerFunction comments correction #1484

CDKnightNASA opened this issue Nov 12, 2024 · 0 comments
Labels
good first issue Good for newcomers

Comments

@CDKnightNASA
Copy link
Contributor

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

* \param HandlerFunc User defined hook function. Set NULL to delete/clear an entry.

 * \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 [email protected]

@CDKnightNASA CDKnightNASA changed the title OSAL ut_assert UT_SetHandlerFunction comments update OSAL ut_assert UT_SetHandlerFunction comments correction Nov 12, 2024
@dzbaker dzbaker added the good first issue Good for newcomers label Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants