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_CalculateCRC Header has incorrect return description #1585

Closed
zanzaben opened this issue May 27, 2021 · 0 comments · Fixed by #1591
Closed

CFE_ES_CalculateCRC Header has incorrect return description #1585

zanzaben opened this issue May 27, 2021 · 0 comments · Fixed by #1591
Assignees
Labels
docs This change only affects documentation.
Milestone

Comments

@zanzaben
Copy link
Contributor

Describe the bug
The return in the header of CFE_ES_CalculateCRC says it returns error codes but it doesn't. When things go wrong it returns either the input crc or 0 depending on how it went wrong,

Expected behavior
Header should correctly explain what CFE_ES_CalculateCRC can return.

Additional context
If TypeCRC is a non-implemented type then it returns 0.
If DataPtr is null or DataLength is zero it returns the input crc

Reporter Info
Alex Campbell GSFC

@skliper skliper added the docs This change only affects documentation. label May 28, 2021
@skliper skliper added this to the 7.0.0 milestone May 28, 2021
astrogeco added a commit that referenced this issue Jun 2, 2021
Fix #1585, Fix Calculate CRC header return description.
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
Development

Successfully merging a pull request may close this issue.

2 participants