You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Parameter documentation for command codes not complete or always up to date
Describe the solution you'd like
Really the structure is the preferred place to document the parameters, the command code documentation is probably better off just referencing the structure. Need to confirm all the information in the command code documentation is in the structure documentation and then clean.
Describe alternatives you've considered
None
Additional context
Code review
Requester Info
Jacob Hageman - NASA/GSFC
The text was updated successfully, but these errors were encountered:
As part of scrubbing command docs in #1396 I also reviewed the documentation on the structures themselves.
In short - I don't see any major issues here.
In some cases structures are re-used between commands, and the structure documentation is therefore more generic in nature, where the command documentation gets into specifics about how its used. For instance EVS has a generic command that accepts a bitmask, and the CFE_EVS_BitMaskCmd_Payload_t just defines it as follows:
The PR for related issue #1396 also updates the description/verification sections where they were lacking, so it can be associated with this issue too (discussed in CCB 2021-07-28).
Is your feature request related to a problem? Please describe.
Parameter documentation for command codes not complete or always up to date
Describe the solution you'd like
Really the structure is the preferred place to document the parameters, the command code documentation is probably better off just referencing the structure. Need to confirm all the information in the command code documentation is in the structure documentation and then clean.
Describe alternatives you've considered
None
Additional context
Code review
Requester Info
Jacob Hageman - NASA/GSFC
The text was updated successfully, but these errors were encountered: