Partial #1724, update in/out status and nonnull/nonzero tags #1798
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
jphickey
added
the
CCB:Ready
skliper
approved these changes
Aug 10, 2021
jphickey
force-pushed
the
fix-1724-api-doxygen-markup
branch
from
35c502f to
98bc267
Compare
|
Note, I found/fixed a bug in my script that was causing it to not find all the return status codes correctly. Will be pushing an update based on a new run. |
astrogeco
removed
the
CCB:Ready
jphickey
force-pushed
the
fix-1724-api-doxygen-markup
branch
from
98bc267 to
052ad37
Compare
jphickey
added
the
CCB:Ready
First pass at API doxygen scrub, this updates the in/out markings on parameters where they were not correct, and adds nonnull and nonzero tags where appropriate.
jphickey
force-pushed
the
fix-1724-api-doxygen-markup
branch
from
052ad37 to
4703123
Compare
|
CCB:2021-08-11 Review again since there are new commits |
astrogeco
removed
the
CCB:Ready
skliper
approved these changes
Aug 11, 2021
astrogeco
added
the
CCB:Approved
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Aug 16, 2021
2 tasks
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Aug 17, 2021
**Combines** nasa/cFE#1808, v6.8.0-rc1+dev873 **Includes** - nasa/cFE#1790, Port "CFE_UtAssert_SuccessCheck" and related macros from coverage test to functional test #1784, add CFE assert macros to functional test - nasa/cFE#1779, Adds invalid id syslog to for CFE_ES_DeleteApp and CFE_ES_ReloadApp and verifies required reporting - nasa/cFE#1785, Stop memory leak & add cds size test. - nasa/cFE#1765, Mark read only inputs as const - nasa/cFE#1804, Check resource ID idx is less than max - nasa/cFE#1778, Add ES Application Behavior Functional Tests - nasa/cFE#1801, Update CFE_ES_RunLoop documentation - nasa/cFE#1745, Add Message Api Functional Test - nasa/cFE#1798, update in/out status and nonnull/nonzero tags - nasa/cFE#1783, Add External Time Source Functional Tests - nasa/cFE#1800, Add Perf API functional tests Co-authored-by: Jacob Hageman <[email protected]> Co-authored-by: Joseph Hickey <[email protected]> Co-authored-by: Alex Campbell <[email protected]> Co-authored-by: Niall Mullane <[email protected]> Co-authored-by: Paul <[email protected]>
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Aug 17, 2021
**Combines** nasa/cFE#1808, v6.8.0-rc1+dev873 **Includes** - nasa/cFE#1790, Port "CFE_UtAssert_SuccessCheck" and related macros from coverage test to functional test #1784, add CFE assert macros to functional test - nasa/cFE#1779, Adds invalid id syslog to for CFE_ES_DeleteApp and CFE_ES_ReloadApp and verifies required reporting - nasa/cFE#1785, Stop memory leak & add cds size test. - nasa/cFE#1765, Mark read only inputs as const - nasa/cFE#1804, Check resource ID idx is less than max - nasa/cFE#1778, Add ES Application Behavior Functional Tests - nasa/cFE#1801, Update CFE_ES_RunLoop documentation - nasa/cFE#1745, Add Message Api Functional Test - nasa/cFE#1798, update in/out status and nonnull/nonzero tags - nasa/cFE#1783, Add External Time Source Functional Tests - nasa/cFE#1800, Add Perf API functional tests Co-authored-by: Jacob Hageman <[email protected]> Co-authored-by: Joseph Hickey <[email protected]> Co-authored-by: Alex Campbell <[email protected]> Co-authored-by: Niall Mullane <[email protected]> Co-authored-by: Paul <[email protected]>
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
First pass at API doxygen scrub, this updates the in/out markings on parameters where they were not correct, and adds nonnull and nonzero tags where appropriate.
Related to #1724 (but should not close yet)
Testing performed
Build and run all tests
Expected behavior changes
None (documentation only)
System(s) tested on
Ubuntu
Additional context
Note this is "partial" as it does not yet do all the test case verification, those will come later. But the API documentation needs to have these tags correct so the validation scripts know what to look for.
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.