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

Doxygen event documentation needs scrub #508

Closed
skliper opened this issue Feb 6, 2020 · 3 comments · Fixed by #1594
Closed

Doxygen event documentation needs scrub #508

skliper opened this issue Feb 6, 2020 · 3 comments · Fixed by #1594
Assignees
Labels
docs This change only affects documentation. enhancement
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented Feb 6, 2020

Is your feature request related to a problem? Please describe.
Doxygen event output doesn't match code in at least 1 case, see CFE_ES_INITSTATS_INF_EID

Describe the solution you'd like
Scrub event doxygen and confirm it matches actual output (and type)

Describe alternatives you've considered
Maybe #define the string as a single definition and link in documentation

Additional context
N/A

Requester Info
Jacob Hageman - NASA/GSFC

@skliper
Copy link
Contributor Author

skliper commented Apr 29, 2021

Consider adding to the event macro to include the brief, possibly link to code (but not good if it links to a line number...)... adding a reference in code might work, but then you'd need to include all the code in the user's guide instead of just APIs (vs what's in the general doc). Also related to suggestion in #655.

@skliper
Copy link
Contributor Author

skliper commented Apr 29, 2021

Consider not linking the format string into the user's guide, and do it in the developers doc? Could keep the user's guide generic with just the description, and add the necessary doxygen tags in the code to show the format string.

@skliper
Copy link
Contributor Author

skliper commented May 27, 2021

Current plan - replace format string with short description (more useful to user). Can always automate generation of EID/format string mapping from the code if really needed. Confirm type and description is still relevant and remove unused.

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. enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant