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

CFE_ES_RunLoop RunStatus parameter is in/out, documented as in #1762

Closed
skliper opened this issue Aug 4, 2021 · 0 comments · Fixed by #1801 or #1808
Closed

CFE_ES_RunLoop RunStatus parameter is in/out, documented as in #1762

skliper opened this issue Aug 4, 2021 · 0 comments · Fixed by #1801 or #1808
Assignees
Labels
docs This change only affects documentation.
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented Aug 4, 2021

Is your feature request related to a problem? Please describe.
Documented as in:

** \param[in] RunStatus A pointer to a variable containing the Application's
** desired run status. Acceptable values are:
** \arg #CFE_ES_RunStatus_APP_RUN - \copybrief CFE_ES_RunStatus_APP_RUN
** \arg #CFE_ES_RunStatus_APP_EXIT - \copybrief CFE_ES_RunStatus_APP_EXIT
** \arg #CFE_ES_RunStatus_APP_ERROR - \copybrief CFE_ES_RunStatus_APP_ERROR

But set:

* Just in case, also output the status, just in case the app looks at this.
*/
if (RunStatus != NULL)
{
*RunStatus = AppRecPtr->ControlReq.AppControlRequest;
}

Describe the solution you'd like
Update API documentation. Description is also somewhat incomplete, since it's also a way for the app to self exit for the typical case where it's a condition in the while loop.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context about the feature request here.

Requester Info
Full name and company/organization if applicable

@skliper skliper added the docs This change only affects documentation. label Aug 4, 2021
@skliper skliper added this to the 7.0.0 milestone Aug 4, 2021
@jphickey jphickey self-assigned this Aug 4, 2021
jphickey added a commit to jphickey/cFE that referenced this issue Aug 11, 2021
Add better description of the RunStatus input/output parameter.
astrogeco added a commit that referenced this issue Aug 13, 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.
Projects
None yet
2 participants