从主页面引用同一子文件夹中的文件

时间:2017-12-08 12:22:36

标签: markdown doxygen

我正在设置Doxygen文件,看起来有点像这样:

INPUT                  = doc src test
USE_MDFILE_AS_MAINPAGE = doc/README.md

我的文件结构如下所示

├── Doxyfile
├── doc
   ├── CHANGELOG.md
   ├── README.md
   ├── STYLEGUIDE.md
   ├── doxygen
   └── logo.png

README.md看起来像这样:

# Introduction

This page contains the documentation for the project.

## Resources

- [Changelog](doc/CHANGELOG.md)
- [Styleguide](doc/STYLEGUIDE.md)

当我运行doxygen时,我收到以下警告:

  

doc / README.md:7:警告:无法为\ ref命令解析对`doc / CHANGELOG.md'的引用

我的html输出包含README.md的内容,但没有链接。文档(CHANGELOG.mdSTYELGUIDE.md)可以在相关网页下找到,但其内容缺少所有版块标题 - 除了标题外,README.md也是如此。

所有其他文档(类等)按预期生成。将README.md移动到根文件夹无效。

我做错了什么?

Doxygen 1.8.12

1 个答案:

答案 0 :(得分:0)

我做了我应该从头开始做的事情 - 生成一个干净的Doxyfile然后用我当前的做差异。

显然,这是由于将TOC_INCLUDE_HEADINGS设置为3而发生的。将其设置为0可以解决问题,但我必须承认我不知道为什么而且我不明白如何{ {1}}应该有用。