Part #274, Cleanup and add doxygen for cfe_psp.h #381
Merged
+1,247
−1,550
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Describe the contribution
I have not attempted to split up the header, nor removed any functions - I intended to leave those as separate work items in the original issue or open a new issue for them. Can also remove functions in this PR if there is consensus/advice to do so.
Doxygen markup added, along with more detail for @param's, @return's etc.
Moved some existing function header information from the implementation files into
cfe_psp.h
- unless there is platform-specific information in that particular variant's function header comment. The .h file is the logical and central 'source-of-truth' for the function header information, and doubling it up (or tripling/quadrupling in the case of PSP) just leads to inconsistencies when updates occur.Comments referring to
BSPReadCDSRtn
,BSPWriteCDSRtn
andPSPRestartRt
were removed as these seem to be no longer implemented - unless they exist in some other non-public implementation?Also, is
PtrToDataToRead
a bit of a misnomer? (the pointer is for storage of the data no?)Testing performed
Just GitHub CI.
Expected behavior changes
Documentation changes only.
Contributor Info
Avi Weiss @thnkslprpt