You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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).
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 groupOSCPUTime
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.
The text was updated successfully, but these errors were encountered: