使用README.md文件作为Doxygen中的主页

Question

Doxygen状态的文档,我可以在markdown文件中使用PHP Markdown Extra标题,但两者都没有

# Main Page # {#mainpage}

也不

# Main Page # {#index}

工作,但标签不作为纯文本出现在输出中.这是BTW的第一行.

此外,我无法使用上述标签引用该页面,也无法使用文件名称.

我还有一个main.dox包含\mainpage特殊命令的文件,但我也尝试了以上所有操作,并在它们之前删除了一个斜杠(仅使它只有两个).

我正在使用Doxygen 1.8.2(已下载)和1.8.1.1(来自MacPorts)执行此任务.

那怎么能实现呢？

另外,如何将markdown文件标记为特定语言的一部分？

编辑:我启用了markdown支持,文件出现在引用的页面中.

Answer 1

在doxygen(1.8.3)的下一个版本中,我计划引入一个新的配置选项USE_MDFILE_AS_MAINPAGE,该选项可用于指定将用作主页面的降价页面.然后你可以配置doxygen如下:

INPUT                  = README.md other_sources
USE_MDFILE_AS_MAINPAGE = README.md

无论页面标题如何,它都能正常工作.

Answer 2

请尝试以下操作,将标题标记为1级标题:

Main Page {#mainpage}
=========

使用doxygen 1.8.2,这使页面成为index.html我的页面.

doxygen文档确实说明,使用单个行开始一行#声明了1级标题,但它似乎对我不起作用.