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

Missing sections in API documentation #125

Open
wpiet opened this issue Sep 26, 2024 · 1 comment
Open

Missing sections in API documentation #125

wpiet opened this issue Sep 26, 2024 · 1 comment

Comments

@wpiet
Copy link
Contributor

wpiet commented Sep 26, 2024

Apparently, there is an issue with doxygen groups (Breathe's .. doxygengroup:: directive) used for embedding doxygen comments in the documentation.

If there are nested groups in some header file, referencing an outer group in RST file produces documentation only for this explicitly referenced group, excluding nested groups defined in the same scope.

Example:
apache-mynewt-core/kernel/os/include/os/os_cputime.h contains a group OSCPUTime wrapped around the whole file.
In that group there is another one OSCPUTime_cmp_macros.
The outcome in API section is that the macros part is not documented at all.

I tried adding :inner: option to the directive, as described here, but it did not work.

Possible fix:
Either add all groups explicitly to relevant RST files or change doxygen comments directly in header files, adjusting the groups - if possible.

@wpiet
Copy link
Contributor Author

wpiet commented Sep 30, 2024

There is another issue (originating from doxygen) causing anonymous structs and unions to be not documented in XML output (which we use to generate PDF documentation and HTML one as well).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant