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

时间:2012-11-13 20:36:30

标签: markdown doxygen doxywizard

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支持,文件显示在引用的页面中。

2 个答案:

答案 0 :(得分:108)

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

INPUT                  = README.md other_sources
USE_MDFILE_AS_MAINPAGE = README.md

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

答案 1 :(得分:14)

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

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

使用doxygen 1.8.2,这会使页面成为index.html页面。

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