I'm creating a project in embedded and there is a problem that usually there are tons of #defines in the header files describing every bit of a register etc.
Example:
/** * @defgroup register_1 Register 1 options * @{ */#defineREGISTER1_BIT0_MASK0x01U/**< @brief bla bla bit mask. */#defineREGISTER1_BIT0_OPTION10x00U/**< @brief bla bla. */#defineREGISTER1_BIT0_OPTION20x01U/**< @brief bla bla. *//** @} */
Using the approach above leads to creating a group in HTML, which is a bit inconvenient, as the user needs to click the link.
Grouping the defines by name:
/** * @name Register 1 options * @{ */#defineREGISTER1_BIT0_MASK0x01U/**< @brief bla bla bit mask. */#defineREGISTER1_BIT0_OPTION10x00U/**< @brief bla bla. */#defineREGISTER1_BIT0_OPTION20x01U/**< @brief bla bla. *//** @} */
lists all the options on the same page. Although the group has it's own header, it's visible and disturbing. Imagine having 40 registers and descibing every bit. So the documentation becomes hard to navigate, as the user needs to go either deeper and deeper or see everything on one spot.
Is there a way to have a group (@defgroup) which can be folded/unfolded instead of a link to another page?
Something like a navindex, but with details and all the grouping included and the user would just unfold the group to see the details instead of going to another page. This leads to a back-and-forth navigating etc, which is inconvenient.
Is there a plan to have such functionality in doxygen? This would significantly improve the navigation in my opinion.
Thank you,
Vojtech
Edit: Included two pictures. One picture depicts the situation how the grouping looks like and the other once a user clicks on the link. Also the description of the macros are below the define, but this takes a lot of space and also it's a bit chaotic. Is there a way to have it on the same line as the defines?
Hi guys,
I'm creating a project in embedded and there is a problem that usually there are tons of #defines in the header files describing every bit of a register etc.
Example:
Using the approach above leads to creating a group in HTML, which is a bit inconvenient, as the user needs to click the link.
Grouping the defines by name:
lists all the options on the same page. Although the group has it's own header, it's visible and disturbing. Imagine having 40 registers and descibing every bit. So the documentation becomes hard to navigate, as the user needs to go either deeper and deeper or see everything on one spot.
Is there a way to have a group (@defgroup) which can be folded/unfolded instead of a link to another page?
Something like a navindex, but with details and all the grouping included and the user would just unfold the group to see the details instead of going to another page. This leads to a back-and-forth navigating etc, which is inconvenient.
Is there a plan to have such functionality in doxygen? This would significantly improve the navigation in my opinion.
Thank you,
Vojtech
Edit: Included two pictures. One picture depicts the situation how the grouping looks like and the other once a user clicks on the link. Also the description of the macros are below the define, but this takes a lot of space and also it's a bit chaotic. Is there a way to have it on the same line as the defines?
Last edit: Vojtech Musil 2017-08-23