List of functions on the main page using doxygen

Question

I'm sure this has already been asked somewhere, but I can’t find it, so here it is.

I am creating a C program and using Doxygen to create documentation. I am quite pleased with the results, however there is no content on the main page. I would like to fill out the main page with a list of all the functions and structures used in the program in alphabetical order.

I don’t know much about Doxygen, apart from the simple tutorial that I used to achieve this. This is similar to the task that Doxygen can do, but for now, all I have found is instructions on how to create a custom homepage.

Can I use Doxygen to automatically create a list of functions and structures on the main page?

Answer 1

I recommend you use @mainpage. This function changed the title of the main page, and then after it you can use functions such as @brief for brief information.

Use html tags to create partitions, it works for me. Then in the new section with the @see function, you can go from the main page to functions or files. This is a working example:

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