Fix #1355, improve documentation for resourceID patterns #1382
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
Improve the doxygen documentation on the various helper functions and common patterns dealing with Resource IDs. Specifically, document that the "IsMatch()" functions accept NULL pointers to allow use with initial validation (gatekeeper), but all other helper functions assume a non-NULL pointer.
Fixes #1355
Testing performed
Build and sanity check CFE, build design docs
Expected behavior changes
None - documentation only, no code change here
System(s) tested on
Ubuntu 20.04
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.