【问题标题】:Reference files in same subfolder from main page从主页参考同一子文件夹中的文件
【发布时间】:2018-05-22 16:45:47
【问题描述】:

我正在设置一个 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

【问题讨论】:

    标签: markdown doxygen


    【解决方案1】:

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

    显然,这是由于将 TOC_INCLUDE_HEADINGS 设置为 3 造成的。将其设置为 0 可以解决此问题,尽管我必须承认我不知道为什么,也不知道 TOC_INCLUDE_HEADINGS 应该如何工作.

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2022-01-18
      • 2022-08-21
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2018-07-18
      • 2019-05-11
      相关资源
      最近更新 更多