Danh sách chức năng trên trang chính với doxygen

Question

Tôi chắc chắn rằng điều này đã được yêu cầu ở đâu đó nhưng tôi dường như không thể tìm thấy nó, vì vậy ở đây nó đi.

Tôi đang tạo một chương trình trong C và sử dụng Doxygen để tạo tài liệu. Tôi khá hài lòng với kết quả, tuy nhiên trang chính không có nội dung. Tôi muốn điền vào trang chính với danh sách tất cả các chức năng và cấu trúc được sử dụng trong chương trình theo thứ tự bảng chữ cái.

Tôi không biết nhiều về Doxygen, ngoài hướng dẫn đơn giản mà tôi đã sử dụng để đạt được điều này. Nó có vẻ như một nhiệm vụ mà Doxygen có thể làm, nhưng cho đến nay tất cả những gì tôi tìm thấy là hướng dẫn cách tạo một trang chính tùy chỉnh.

Có thể sử dụng Doxygen để tự động tạo danh sách các chức năng và cấu trúc trên trang chính không?

Answer 1

Tôi khuyên bạn nên sử dụng @mainpage. Chức năng này đã thay đổi tiêu đề của trang chính và sau đó, sau đó bạn có thể sử dụng các hàm như @brief để biết thông tin ngắn.

Sử dụng thẻ html để tạo các phần, cho tôi nó hoạt động. Sau đó, trong phần mới với chức năng @see bạn có thể đi từ trang chính đến các chức năng hoặc tập tin. Đây là một bài tập làm việc:

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