Doxygen：如何从我的主页引用 README.md 文件

Question

我有一个这样结构的项目。

OpenRGB-cppSDK
  doc
    Doxyfile
    main.md  -- Doxygen main page
  examples
    .cpp files with examples
  include
    public .hpp files
  src
    .hpp and .cpp files
  tools
    cli demo
README.md  -- github main page

现在我想从 main.md 创建对 README.md 文件和 examples 目录的可点击引用，但我不知道如何做。

我已将 README.md 和 examples 添加到 INPUT 变量

INPUT                  = ../doc ../include ../src ../README.md ../examples

并且我已经验证 FILE_PATTERNS 包括 *.md。

然而当我像这样写一个句子到main.md时

Basic examples are in the \ref README.md, more advanced examples in directory \ref examples.

doxygen 告诉我它无法解析对 README.md 和示例的引用，即使我可以在其输出中看到它找到了文件

Reading E:/Youda/Projects/OpenRGB-cppSDK/README.md...
Generating docs for page md_E__Youda_Projects_OpenRGB_cppSDK_README...
Preprocessing E:/Youda/Projects/OpenRGB-cppSDK/examples/ContinuouslyUpdateColors.cpp...
Parsing file E:/Youda/Projects/OpenRGB-cppSDK/examples/ContinuouslyUpdateColors.cpp...
...

在生成的网页中，它显示了一个带有条目“OpenRGB_cppSDK”的按钮“相关页面”，它将我带到自述文件

但是 main.md 对 README 的引用不起作用。

我也尝试过 EXTRACT_ALL = YES，但是 main.md 页面获得了对 README.md 的可点击引用，但是当我点击它时，它会将我带到看起来像这样的空白页面

拜托，我做错了什么？

Answer 1

降价类型link的版本有效：[Test with md type](../README.md)

完整项目： README.md

# this is the readme file

this is the readme file

doc/main.md

# this is the main file

this is the main file


the test with \ref no path: \ref README.md

the test with \ref with path: \ref ../README.md


[Test with md type](../README.md)

doc/Doxyfile

QUIET=YES
INPUT                  = ../doc ../README.md

输出：doc/html/md_main.html

为什么 \ref 不起作用，来自文档：

24.107 \ref <name> ["(text)"]

Creates a reference to a named section, subsection, page or anchor. For HTML documentation the reference command will generate a link to the section. For a section or subsection the title of the section will be used as the text of the link. For an anchor the optional text between quotes will be used or if no text is specified. For LATEX documentation the reference command will generate a section number for sections or the text followed by a page number if refers to an anchor.

“../README.md”不是有效名称当“README.md”是本地文件（即 doc 目录的本地文件）时，它会起作用。

Doxygen：如何从我的主页引用 README.md 文件

Doxygen: How to reference a README.md file from my main page

doxygen

hyperlink

filereference

readme