Doxygen:头文件的 Markdown 链接在 html 输出中损坏
Doxygen: markdown links to header files are broken in html output
我的 markdown 文件中的大部分 link 都由 Doxygen(Fedora 28 上的版本 1.8.14)正确呈现,例如:
[utils](src/thing/utils/README.md)
尽管 Doxygen 的 html 版本自述文件的路径是神秘的,但 Doxygen 解决了它并且 link 起作用了。但是当我 link 到一个头文件时,Doxygen 生成了一个奇怪的相对路径,它无处可去:
[Widget.hpp](src/thing/utils/Widget.hpp)
在 github 上这个 link 有效,但是 Doxygen 生成的 html 中的路径是:
../../src/thing/utils/Widget.hpp
我希望 Doxygen 将此 link 解析为它为 Widget.hpp
生成的 html 文档页面。有没有办法做到这一点,并保持与 github 的兼容性?如果它需要 Doxygen 预处理器或什至我自己的预处理脚本(到 Doxygen 之前的 运行 并将 README.md
的临时副本中的 link 更改为 Doxygen 理解的内容,我觉得很好) .
有点困难。
文件README.md由doxygen翻译并使用结果。 widget.hpp 也被翻译了,但由于不清楚 link 是什么,即源代码或文档,提供了对原始文件的引用,但在结果树中,该文件被视为一个文件可以在那个位置的 HTML 树中找到。
所以您最好在 HTML 目录中创建路径并将文件复制到该位置。
另外,最好在 doxygen 问题跟踪器 (https://github.com/doxygen/doxygen/issues/new) 中创建一个问题,并附上一个小型的自包含示例(tar 或 zip 中的源+配置文件;请不要引用外部资源),这样可以重现问题。
我的 markdown 文件中的大部分 link 都由 Doxygen(Fedora 28 上的版本 1.8.14)正确呈现,例如:
[utils](src/thing/utils/README.md)
尽管 Doxygen 的 html 版本自述文件的路径是神秘的,但 Doxygen 解决了它并且 link 起作用了。但是当我 link 到一个头文件时,Doxygen 生成了一个奇怪的相对路径,它无处可去:
[Widget.hpp](src/thing/utils/Widget.hpp)
在 github 上这个 link 有效,但是 Doxygen 生成的 html 中的路径是:
../../src/thing/utils/Widget.hpp
我希望 Doxygen 将此 link 解析为它为 Widget.hpp
生成的 html 文档页面。有没有办法做到这一点,并保持与 github 的兼容性?如果它需要 Doxygen 预处理器或什至我自己的预处理脚本(到 Doxygen 之前的 运行 并将 README.md
的临时副本中的 link 更改为 Doxygen 理解的内容,我觉得很好) .
有点困难。
文件README.md由doxygen翻译并使用结果。 widget.hpp 也被翻译了,但由于不清楚 link 是什么,即源代码或文档,提供了对原始文件的引用,但在结果树中,该文件被视为一个文件可以在那个位置的 HTML 树中找到。
所以您最好在 HTML 目录中创建路径并将文件复制到该位置。
另外,最好在 doxygen 问题跟踪器 (https://github.com/doxygen/doxygen/issues/new) 中创建一个问题,并附上一个小型的自包含示例(tar 或 zip 中的源+配置文件;请不要引用外部资源),这样可以重现问题。