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

Provide file for cFE detail design #1069

Closed
jphickey opened this issue Jun 9, 2021 · 1 comment · Fixed by #1070 or #1076
Closed

Provide file for cFE detail design #1069

jphickey opened this issue Jun 9, 2021 · 1 comment · Fixed by #1070 or #1076
Milestone

Comments

@jphickey
Copy link
Contributor

jphickey commented Jun 9, 2021

Is your feature request related to a problem? Please describe.
By default, when building cFE mission "detail design" document, the entire module directory is added to the doxygen input, which will recursively pick up all source files, but also everything else too.

This can lead to conflicts with e.g. "mainpage", where OSAL provides its own mainpage for its API guide, but this should NOT be used for other documentation that includes OSAL, like the detail design doc.

Describe the solution you'd like
OSAL should provide a detaildesign template file that indicates which sources should be used, rather than everything.

Describe alternatives you've considered
cFE itself could exclude certain parts in its templates, but that means cFE must have knowledge of OSAL directory tree.

Additional context
Related to nasa/cFE#1612

Requester Info
Joseph Hickey, Vantage Systems, Inc.

@skliper
Copy link
Contributor

skliper commented Jun 9, 2021

Could/should be generic, any higher level detailed design doxygen build could include the OSAL detailed design info. Not specific to the cFE detailed design document.

jphickey added a commit to jphickey/osal that referenced this issue Jun 9, 2021
This file indicates which input dirs to use for the cFE detail
design document.  It should be controlled with OSAL, as this
knows the detail of the directory tree.
jphickey added a commit to jphickey/osal that referenced this issue Jun 9, 2021
This file indicates which input dirs to use for the cFE detail
design document.  It should be controlled with OSAL, as this
knows the detail of the directory tree.
astrogeco added a commit that referenced this issue Jun 15, 2021
@skliper skliper added this to the 6.0.0 milestone Sep 24, 2021
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants