如何显示 Doxygen 配置变量？

Question

我正在尝试显示存储在 Doxygen 配置变量中的值。一个简单的例子是标准 Doxyfile 配置文件中的 "PROJECT_NAME" 变量。如何在代码中的任意位置显示它？

我创建了一个名为 main.dox 的文件，其中包含以下内容：

/*!  \mainpage Main Page

- @PROJECT_NAME
- @PROJECT_NAME
- $PROJECT_NAME
- ${PROJECT_NAME}

 */

PROJECT_NAME 的值在标准 Doxyfile 配置中设置为 "MY DOCS"。标题正确显示在文档顶部。然而，在主页上，上面的代码生成以下内容：

*
*
* $PROJECT_NAME
* ${PROJECT_NAME}

如何让它在生成的输出中显示 MY DOCS？

Answer 1

你不知道。 Doxygen 无法将配置变量的文本注入代码中的任意点。

然而，您可以写一个 custom command，一个 alias/macro，可用于在不同位置重复文本。当然，您必须重复项目名称的文本，但它会在配置文件中重复：

PROJECT_NAME = Project Name
ALIASES += projname="Project Name"

在您的文档评论中，您现在可以使用 \projname 或 @projname。