如何解决Doxygen:如何从我的主页引用 README.md 文件
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
现在我想从 README.md
创建对 examples
文件和 main.md
目录的可点击引用,但我不知道如何。
我已将 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 的可点击引用,但是当我点击它时,它会将我带到一个看起来像这样的空白页面
请问,我做错了什么?
解决方法
带有 markdown 类型链接的版本确实有效:[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)
文档/Doxyfile
QUIET=YES
INPUT = ../doc ../README.md
输出:doc/html/md_main.html
为什么 \ref
不起作用,来自文档:
24.107 \ref
创建对命名部分、子部分、页面或锚点的引用。对于 HTML 文档,参考命令将生成指向该部分的链接。对于一节或小节,该节的标题将用作链接的文本。对于锚点,将使用引号之间的可选文本,或者如果未指定文本。对于 LATEX 文档,参考命令将为节生成节号,或者如果引用锚点,则生成后跟页码的文本。
“../README.md”不构成有效名称
当“README.md”是本地文件(即本地到 doc
目录)时,它会起作用。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。