Lista funkcji na głównej stronie z doxygenem

Question

Jestem pewien, że to już zostało gdzieś zapytane, ale nie mogę tego znaleźć, więc proszę.

Tworzę program w C i używając Doxygen do generowania dokumentacji. Jestem całkiem zadowolony z wyników, jednak strona główna nie zawiera żadnych treści. Chciałbym wypełnić stronę główną listą wszystkich funkcji i struktur używanych w programie w porządku alfabetycznym.

Nie wiem zbyt wiele na temat Doxygen, poza prostym samouczkiem, którego użyłem do osiągnięcia tak daleko. Wydaje się, że to zadanie, które Doxygen byłby w stanie wykonać, ale jak dotąd wszystko, co znalazłem, to instrukcje, jak stworzyć niestandardową stronę główną.

Czy można używać Doxygen do automatycznego generowania listy funkcji i struktur na stronie głównej?

Answer 1

Polecam ci użyć @mainpage. Ta funkcja zmieniła nagłówek strony głównej, a następnie po niej można użyć funkcji takich jak @brief, aby uzyskać krótką informację.

Użyj tagów html do tworzenia sekcji, dla mnie to działa. Następnie w nowej sekcji z funkcją @see możesz przejść od strony głównej do funkcji lub plików. Jest to działająca operacja:

/** 
*  @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/> 
*/