Question

有没有办法从git获取Doxygen的信息：例如：

@version
@author
@date

该信息应自动包含在Doxygen评论中。

对于@version，可能会获得标签信息。

非常感谢提前！

Answer 1

我意识到这是一个比较老的问题，但是我只是想做同样的事情。

评论中的两个链接答案都不能很好地解决此问题。我们可能希望包括在生成的文档中进行了git修订，而在我们的工作资料中没有涉及git过滤器等。

幸运的是。 Doxygen支持在Doxyfile中使用环境变量，并提供各种设置可用于将信息放置在生成的内容中。 PROJECT_NUMBER设置专门用于在文档中包含版本控制信息。

如果我们在Doxyfile中有此标签：

PROJECT_NUMBER = $(PROJECT_NUMBER)

您可以像这样运行doxygen，以便在生成的文档中包含git版本：

PROJECT_NUMBER=$(git rev-parse --short HEAD) doxygen

您也不仅限于提交ID。例子：

PROJECT_NUMBER=$(git log -1 --format "%h (%cd)") doxygen

这使生成的HTML中的标题看起来像：

<div id="projectname">MyProject
&#160;<span id="projectnumber">9dd847b (Fri Feb 1 15:36:13 2019 -0500)</span>
</div>