Fix #20, doxygen updates #156
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Note for review, the actual commit is in 6457697, needs a rebase after the next baseline. |
48eb40e
to
fce325c
Compare
Make sure _all_ functions in CF have a doxygen block on the declaration describing the inputs and outputs and a general summary of what the function does. Additionally describe the purpose of structures and structure members where it is not totally obvious from the name. Note: this also renames one member, CF_max_chunks, that appears to have been improperly scooped up in a previous batch rename.
fce325c
to
e494933
Compare
|
Rebased to current "main". Also added a note, per recent CCB discussion, indicating that the "CF_EntityId_t" and "CF_TransactionSeq_t" types are used in commands and configuration tables, and that changing the definition of those types is going to also change the size/layout of the dependent CMD structures. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Describe the contribution
Make sure all functions in CF have a doxygen block on the declaration describing the inputs and outputs and a general summary of what the function does.
Additionally describe the purpose of structures and structure members where it is not totally obvious from the name.
Note: this also renames one member, CF_max_chunks, that appears to have been improperly scooped up in a previous batch rename.
Fixes #20
Testing performed
Build and sanity check CF operation. This does not change any actual FSW or unit test logic.
Expected behavior changes
No impact to behavior, this only changes documentation (aside from the one rename)
System(s) tested on
Ubuntu 21.10
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.