Use the README.md file as main page in Doxygen

前端 未结 2 946
轻奢々
轻奢々 2020-12-12 20:47

The documentation of Doxygen states, that I can use PHP Markdown Extra title labelling in a markdown file, but neither

# Main Page # {#mainpage}
2条回答
  •  悲&欢浪女
    2020-12-12 21:21

    In the next release of doxygen (1.8.3) I plan to introduce a new configuration option USE_MDFILE_AS_MAINPAGE which can be used to specify a markdown page that is to be used as the main page. Then you can configure doxygen as follows:

    INPUT                  = README.md other_sources
    USE_MDFILE_AS_MAINPAGE = README.md
    

    and it will work regardless of page's headings.

提交回复
热议问题