是否可以選擇顯示哪個Doxygen警告？

Doxygen在建築時顯示Compound ? is not documented.警告。對於一個特定的項目，我不想記錄化合物。爲了消除混亂，我希望看到除此之外的所有其他警告。有沒有辦法清潔Doxygen輸出？是否可以選擇顯示哪個Doxygen警告？

來源

2011-06-13 Jader Dias

我不認爲這是可能的，除非編寫自己的後處理器來過濾Doxygen輸出。在你的情況，這應該不是太難，一個簡單的grep應該是足夠了：

doxygen <config_file> | grep -v "warning: Compound .* is not documented"

我真的不知道爲什麼Doxygen的不提供此功能：也許會需要太多的選項，或更復雜選項。另一種可能性是，他們認爲，因爲當某些事情沒有記錄時你想要被警告，除非在源代碼中明確指定（例如使用\cond和\endcond），否則不應該有例外，理由是這種省略應該只根據具體情況來決定。或者也許沒有人要求他們包含此功能：請隨時填寫feature request。

來源

2011-06-21 16:34:43

我認爲你要找的是if,ifnot和命令。只需決定一個合適的標籤，然後使用正確的標籤。例：如果知道這個標籤的，如果沒有，他會在同一個註釋塊忽略任何評論到\endif命令

/* 
* \if DISPLAY_COMPOUND 
* Compound doc. 
* ... 
* \endif 
*/

的doxygen將評估

然後，你需要在ENABLED_SECTIONS的doxyfile中定義（或不）該標籤。

#comment the next line if you don't want to document Compound 
ENABLED_SECTIONS = DISPLAY_COMPOUND

看一看在\cond和\endcond命令太是相似的，但不完全一樣（它們啓用或禁用文件的整個部分，而不僅僅是一個單一的註釋塊）。

來源

2011-06-16 17:23:48 SolarBear

我說的Doxyfile'ENABLED_SECTIONS ='（空白）。你的回答不包括我的問題。我不想啓用或禁用複合文檔生成。我想禁用化合物警告。 – 2011-06-17 13:09:18

您可以關閉doxygen配置中的警告。在這裏看到：doxygen documenation

我最喜歡的是：WARN_IF_UNDOCUMENTED = NO

來源

2013-11-20 10:46:17 Ralf

你把這個選項放在哪裏？我不能承認.. – 2014-08-05 10:00:14

是否可以選擇顯示哪個Doxygen警告？

回答

相關問題