git - 用于自动化文件版本信息的 Doxygen 和 git

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>