如何顯示Doxygen配置變量？

Question

我想顯示存儲在Doxygen配置變量中的值。一個簡單的例子是標準Doxyfile配置文件中的「PROJECT_NAME」變量。我如何在代碼中的任意位置顯示它？

我已經成立了一個名爲main.dox與文件，內容如下：

/*! \mainpage Main Page 

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

*/ 

爲PROJECT_NAME的值設置爲"MY DOCS"標準的Doxyfile的配置。標題正確顯示在文檔的頂部。在主頁面，然而，上面的代碼生成以下內容：

* 
* 
* $PROJECT_NAME 
* ${PROJECT_NAME} 

我怎樣才能得到它，以顯示生成的輸出MY DOCS？

Answer 1

你不知道。 Doxygen無法將配置變量的文本插入代碼中的任意點。

然而，您可以編寫一個custom command，這是一個別名/宏，可用於在各個位置重複文本。當然，你必須重複你的項目名稱的文本，但它會在配置文件中重複：

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

在你的文檔註釋，你現在可以使用\projname或@projname。