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

Update doxygen groupnames to match cFS naming conventions #1697

Open
astrogeco opened this issue Jul 20, 2021 · 0 comments
Open

Update doxygen groupnames to match cFS naming conventions #1697

astrogeco opened this issue Jul 20, 2021 · 0 comments
Labels
docs This change only affects documentation.

Comments

@astrogeco
Copy link
Contributor

astrogeco commented Jul 20, 2021

Description

The doxygen "groupnames" do not have any separators and are difficult to read, see CFEAPIESEntryExit in code snippet below.

<LI> \ref CFEAPIESEntryExit
<UL>
<LI> #CFE_ES_Main - \copybrief CFE_ES_Main
<LI> #CFE_ES_ResetCFE - \copybrief CFE_ES_ResetCFE
</UL>
<LI> \ref CFEAPIESAppControl

See short discussion in #1670 (comment)

Proposed Solution

Have the group name match the updated directory structure after the modules update, for example

  • `CFE_CORE_API_ES_EntryExit, or
  • `CFE_ES_EntryExit

Alternatives

Leave names as is but introduce underscores CFE_API_ES_EntryExit.

@astrogeco astrogeco added the docs This change only affects documentation. label Jul 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change only affects documentation.
Projects
None yet
Development

No branches or pull requests

1 participant