Doxygen 项目简介可以包含 link 吗？

Question

我正在编写我的 Doxyfile 配置，想知道我是否可以在 PROJECT_BRIEF 中包含一个 link。我试过 HTML 和 Markdown 语法，但它似乎只接受明文。有没有办法向 PROJECT_BRIEF 添加简单的标记？

PROJECT_BRIEF = "Project heavily inspired by <a href='https://example.com'>Other Project</a>"

PROJECT_BRIEF = "Project heavily inspired by [Other Project](https://example.com)"

我的系统目前安装了 Doxygen 1.8.17。

Answer 1

我设法使用自定义 HTML_HEADER 来完成此操作。

生成默认模板（我们只会查看 header.html）。

doxygen -w html header.html footer.html stylesheet.css Doxyfile
rm footer.html stylesheet.css

修改header.html.

找到现有的 $projectbrief 标签。

<div id="projectbrief">$projectbrief</div>

添加一些 javascript 以“取消转义”HTML。

<script>
  function htmlDecode(input) {
    var doc = new DOMParser().parseFromString(input, "text/html");
    return doc.documentElement.textContent;
  }
  document.getElementById("projectbrief").innerHTML = htmlDecode("$projectbrief");
</script>

修改Doxyfile以使用新的HTML_HEADER

HTML_HEADER = header.html

欣赏您的标记！

注意：其他输出类型（例如 LaTeX）也可以类似地使用自定义头文件。

此外，理论上可以使用任意数量的 JavaScript Markdown 解析器使用 Markdown 语法。

Doxygen 项目简介可以包含 link 吗？

Can Doxygen project brief contain link?

doxygen

configuration-files

documentation-generation