使用README.md文件中的Doxygen主页(Use the README.md file as

2019-07-03 19:17发布

使用Doxygen的文档指出,我可以使用PHP降价额外的标题标签的降价文件,但也

# Main Page # {#mainpage}

也不

# Main Page # {#index}

工作,但该标签是不存在的输出为纯文本两种。 这是BTW的第一行。

我也不能引用到该页面没有上述标签,也没有用的文件名。

我也有一个main.dox包含文件\mainpage特殊的命令,但我也尝试了所有的上面取出之前一个斜杠(使它只有两个)。

我使用Doxygen的1.8.2(下载)和1.8.1.1(从MacPorts的)来完成任务。

我怎样才能做到这一点呢?

另外,我怎么可以标记降价文件作为特定语言的一部分吗?

编辑:我已经启用了降价的支持,并且该文件出现在引用的页面。

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级标题,但它似乎不是为我工作无论是。



文章来源: Use the README.md file as main page in Doxygen