c - Function list on main page with doxygen -


i'm sure has been asked somewhere can't seem find it, here goes.

i creating program in c , using doxygen generate documentation. quite satisfied results, main page has no content. fill main page list of functions , structures used in program in alphabetical order.

i not know doxygen, beyond simple tutorial have used far. seems task doxygen able do, far have found instructions on how create custom main page.

is possible use doxygen automatically generate list of functions , structures on main page?

i recommend use @mainpage. function changed header of main page , after can use functions @brief short information.

use html tags create sections, me works. in new section function @see can go main page functions or files. working excample:

/** *       @mainpage watchdog  *       <hr/> *       @setion <b> file tree<b/> *       @brief here can see main files used. *       @see io.c *       @see watchdog.c *       @see watchdog.h *       <p/><br/> *       <hr/> *       in part have few main functions used 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/> */ 

Comments

Popular posts from this blog

Magento/PHP - Get phones on all members in a customer group -

php - .htaccess mod_rewrite for dynamic url which has domain names -

Website Login Issue developed in magento -