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 should use relevant "module" defs to organize the docs #486

Open
wmamills opened this issue Apr 25, 2023 · 4 comments
Open

doxygen should use relevant "module" defs to organize the docs #486

wmamills opened this issue Apr 25, 2023 · 4 comments
Assignees
Labels

Comments

@wmamills
Copy link
Collaborator

Zephyr uses doxygengroup to integrate doxygen content in place in the sphinx docs.
We plan to do this as well.

libmetal already has well defined "groups" aka "modules" that organize the content into API sub groups.

open-amp should do the same. This can be done and tested before Sphinx integration by just browsing the "modules" pull down menu in the default doxygen content.

@github-actions
Copy link

This issue has been marked as a stale issue because it has been open (more than) 45 days with no activity.

@github-actions github-actions bot added the Stale label Oct 14, 2023
@wmamills wmamills reopened this Oct 24, 2023
@wmamills
Copy link
Collaborator Author

This is not done

@wmamills
Copy link
Collaborator Author

Please compare: https://openamp.readthedocs.io/en/latest/doxygen/openamp/modules.html
And https://openamp.readthedocs.io/en/latest/doxygen/libmetal/modules.html

libmetal is much better organized and easier to understand.

@github-actions github-actions bot removed the Stale label Oct 25, 2023
Copy link

github-actions bot commented Dec 9, 2023

This issue has been marked as a stale issue because it has been open (more than) 45 days with no activity.

@github-actions github-actions bot added the Stale label Dec 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants