Elenco delle funzioni sulla pagina principale con doxygen

Question

Sono sicuro che questo è già stato chiesto da qualche parte ma non riesco a trovarlo, quindi eccolo qui.

Sto creando un programma in C e utilizzando Doxygen per generare documentazione. Sono abbastanza soddisfatto dei risultati, tuttavia la pagina principale non ha contenuto. Vorrei riempire la pagina principale con un elenco di tutte le funzioni e le strutture utilizzate nel programma in ordine alfabetico.

Non so molto di Doxygen, al di là del semplice tutorial che ho usato per arrivare così lontano. Sembra un compito che Doxygen sarebbe in grado di fare, ma finora tutto ciò che ho trovato sono le istruzioni su come creare una pagina principale personalizzata.

È possibile utilizzare Doxygen per generare automaticamente un elenco di funzioni e strutture nella pagina principale?

Answer 1

Vi consiglio di utilizzare @mainpage. Questa funzione ha cambiato l'intestazione della pagina principale e successivamente è possibile utilizzare funzioni come @brief per una breve informazione.

Utilizzare tag html per creare sezioni, per me funziona. Quindi nella nuova sezione con function @ see puoi passare dalla pagina principale a funzioni o file. Questo è un esempio di lavoro:

/** 
*  @mainpage WATCHDOG 
*  <hr/> 
*  @setion <b> File tree<b/> 
*  @brief Here you can see the main files which are used. 
*  @see io.c 
*  @see watchdog.c 
*  @see watchdog.h 
*  <p/><br/> 
*  <hr/> 
*  In this part we have few main functions used by the programm 
*  <p/><br/> 
*  @see watchdog_init_s(); 
*  @see fpga_resetregs_init_s(); 
*  @see watchdog_read(int add, unsigned int ws); 
*  @see watchdog_reset_io_write(WD * watchdog, unsigned int* data,unsigned int *ws); 
*  <hr/> 
*/