wpiet opened a new issue, #125:
URL: https://github.com/apache/mynewt-documentation/issues/125

   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 
](https://mynewt.apache.org/master/os/core_os/cputime/os_cputime.html#api) is 
that the macros part is not documented at all.
   
   I tried adding `:inner:` option to the directive, as described 
[here](https://breathe.readthedocs.io/en/latest/group.html#inner-example), 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.
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to