如何显示Doxygen配置变量?

时间:2017-08-15 16:38:50

标签: doxygen

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

我已经设置了一个名为main.dox的文件,其中包含以下内容:

/*!  \mainpage Main Page

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

 */

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

*
*
* $PROJECT_NAME
* ${PROJECT_NAME}

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

1 个答案:

答案 0 :(得分:1)

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

然而,你可以写一个custom command,一个可用于在不同位置重复文本的别名/宏。当然,您必须重复项目名称的文本,但它将在配置文件中重复:

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

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