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

Doxygen description of stub for CFE_SB_SendMsg is not correct #938

Closed
asgibson opened this issue Oct 1, 2020 · 1 comment · Fixed by #1015
Closed

Doxygen description of stub for CFE_SB_SendMsg is not correct #938

asgibson opened this issue Oct 1, 2020 · 1 comment · Fixed by #1015
Labels
docs This change only affects documentation. unit-test
Milestone

Comments

@asgibson
Copy link
Contributor

asgibson commented Oct 1, 2020

Describe the bug
Description on the stub for CFE_SB_SendMsg is out of date.

Expected behavior
Update description

Code snips

** \par Description
** This function is used to mimic the response of the cFE SB function
** CFE_SB_SendMsg. The user can adjust the response by setting
** the values in the SBSendMsgRtn structure prior to this function
** being called. If the value SBSendMsgRtn.count is greater than
** zero then the counter is decremented; if it then equals zero the
** return value is set to the user-defined value SBSendMsgRtn.value.
** CFE_SUCCESS is returned otherwise. Only EVS and TIME messages are
** handled directly by this function; other messages are passed to the
** unit test function, UT_ProcessSBMsg, for any further action.

Reporter Info
Alan Gibson NASA GSFC/587

@asgibson asgibson added docs This change only affects documentation. unit-test labels Oct 1, 2020
@skliper skliper added this to the 7.0.0 milestone Oct 2, 2020
@skliper skliper linked a pull request Jan 15, 2021 that will close this issue
@skliper
Copy link
Contributor

skliper commented Jan 15, 2021

Stub deprecated in #1015, CFE_SB_TransmitMsg stub is documented correctly.

@skliper skliper closed this as completed Jan 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change only affects documentation. unit-test
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants