Doxygen：输出版本号

Question

我想让 Doxygen 将源代码版本号显示为主页或标题的一部分 header。

目前，我们的代码将版本定义为文本文字：

/*!
 *  \brief  Text literal containing the build number portion of the
 *              ESG Application Version.
 */
static const char   build_version_text[] = "105";

我在互联网上搜索了一种方法，可以将上述语句中的 105 放入 Doxygen 主页（或 header），但没有成功。

背景
我们有一个构建服务器，它作为每晚构建操作的一部分更新文本字符串。该文件已更新，然后签入软件配置管理系统。构建服务器还能够生成文档。我们还希望开发人员能够检查代码，在他们的工作站上构建 Doxygen 文档。

我们正在使用 Doxygen 版本 1.8.11。

Answer 1

您正在寻找的是根据源中的值设置 PROJECT_NUMBER 配置选项。我不认为这是可以做到的，但我要达到相同结果的方法如下。

由于构建脚本运行时会更新项目版本，因此让构建脚本生成一个额外的文件，例如Doxyversion。文件内容为：

PROJECT_NUMBER = "<versiontext>"

更新您的主要 Doxyfile 并替换

PROJECT_NUMBER =

和

@INCLUDE = "<pathToDoxyversion>"

编辑：

我能想到的不需要复制版本字符串的解决方案需要将版本字符串从文件中解析到环境变量中。然后你可以设置PROJECT_NUMBER到

PROJECT_NUMBER=$(ENV_VAR)

另一种选择是您可以使用

调用 doxygen

( cat Doxyfile ; echo "PROJECT_NUMBER=$ENV_VAR" ) | doxygen

这两种解决方案都要求开发人员在生成文档或将整个 doxygen 调用包装在脚本中时知道要执行此操作。还有潜在的可移植性问题。

Answer 2

下面的完整解决方案，来自一个真实的例子。

主页

在主页（或任何地方）的文档中，使用特殊标记来动态替换文本。

首页来源： https://github.com/mysql/mysql-server/blob/8.0/sql/mysqld.cc#L22

查看特殊 ${DOXYGEN_GENERATION_DATE} 标记

氧气输入过滤器

在 doxygen 配置文件中，为包含特殊标记的文件定义一个输入过滤器。例如，

FILTER_PATTERNS = "*/sql/mysqld.cc=./doxygen-filter-mysqld"

执行 doxygen-filter-mysqld 脚本以：

找到要替换的动态值（在您的情况下，解析 build_version_text 的值）
用值

sed

将结果输出到stdout

例如：

CMD1="s/\${DOXYGEN_GENERATION_DATE}/"`date -I`"/g"
...
sed -e ${CMD1} -e ${CMD2} -e ${CMD3}

结果

结果在 http://devdocs.no.oracle.com/mysql-server/8.0.0/

另请参阅

所有这些都是我认为应该是一个很好的 Doxygen 功能的变通方法。请参阅为此输入的错误#769679（功能请求：扩展环境变量的 doxygen 命令）。

https://bugzilla.gnome.org/show_bug.cgi?id=769679

Doxygen：输出版本号

Doxygen: Outputting Version Numbers

versioning

doxygen

主页

氧气输入过滤器

结果

另请参阅