Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scrub parameter documentation section of command codes #1395

Closed
skliper opened this issue Apr 20, 2021 · 2 comments · Fixed by #1719
Closed

Scrub parameter documentation section of command codes #1395

skliper opened this issue Apr 20, 2021 · 2 comments · Fixed by #1719
Assignees
Labels
CFS-41 docs This change only affects documentation.
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented Apr 20, 2021

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

@skliper skliper added this to the 7.0.0 milestone Apr 20, 2021
@skliper skliper added docs This change only affects documentation. and removed enhancement labels Apr 29, 2021
@jphickey
Copy link
Contributor

jphickey commented Jul 28, 2021

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:

uint8 BitMask; /**< \brief BitMask to use in the command */

However in the command documentation it says how the specific bits are defined for that particular command.

** The following bit positions apply to structure member named 'BitMask'.
** Bit 0 - Port 1
** Bit 1 - Port 2
** Bit 2 - Port 3
** Bit 3 - Port 4

So in my opinion this is appropriate - I don't see anything I feel compelled to change here.

@jphickey
Copy link
Contributor

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).

@skliper skliper closed this as completed Sep 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CFS-41 docs This change only affects documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants