Organizing Doxygen index list differently/properly

190 Views Asked by At

I'm trying to generate properly organized Doxygen documentation for a work project. The issue I'm having is related to the image below:

module detail list

Everything under the "State Machine" tab are the data structures, macros, typedefs, etc. in that order that belong to the module in different files. Is there any way to get rid of the detailed listing and instead have it grouped as:

  • State Machine
    • Data Structures
      • mdlSM_INV
      • mdlSM...
    • Macros
      • mdlSM_cnf...

So on and so forth?

OR to just get rid of the whole list i.e. just have the name of the module and not have it expand into anything else?

I'm working with Doxywizard and Doxygen version 1.8.18 that I cannot update (at the moment at least) as I don't have admin rights on the computer. The project is in embedded C, written in Code Composer Studio.

EDIT: The current file contents looks something like this:

/*! \addtogroup mdlStatemachine State Machine
 *@brief  Implement state machine
 *
 *@{
 */
 
#include ...

// MACROS
#define mdlSM_cnf_TICKS_PER_MS
#define mdlSM_cnf_SAMPLE_INTERVAL
#define ...


// TYPEDEFS
/*!@brief
 * ...
 */
typedef enum mdlSM_cnf_States
{
    ...
    ...
}mdlSM_cnf_States_t;


/*!@brief
 * ...
 */
typedef struct mdlSM_INV
{
    ...
}mdlSM_INV_t;


// FUNCTIONS
/*!@brief  ...
 *
 */
void SM_init(SM *me, SMState state)
{
    ...
}

// END OF FILE
/*! @}*/

The idea is to put entire files in the modules and not every function etc. individually.

0

There are 0 best solutions below