2015-06-26 15 views
2

我用它重新定義了void類型(其中包括)庫:Doxygen的:如何重新定義無效

#define XX_VOID void 

所以,當我在代碼運行的doxygen像

/** 
* @brief Function description 
*/ 
XX_VOID foo(XX_VOID) 
{ 
    /*...*/ 
} 

我得到的警告

file.c:10: warning: return type of member foo is not documented 

我怎麼能告訴Doxygen的是XX_VOID是無效的,所以沒有返回值?

+0

我不希望像'@return none'添加到使用這種類型的所有功能。 – user4780495

回答

1

您可以用MACRO_EXPANSION標籤嘗試:

MACRO_EXPANSION

如果MACRO_EXPANSION標記設置爲YES,doxygen的將擴大在源代碼中所有宏的名稱。如果設置爲NO,則僅執行條件編譯。通過將EXPAND_ONLY_PREDEF設置爲YES,可以以受控方式進行宏擴展。

默認值爲:NO

該標籤要求標籤ENABLE_PREPROCESSING設置爲YES

隨着MACRO_EXPANSION設置爲YES結果後doxygen的預處理變爲:

void foo(void) 
{ 
    /* ... */ 
} 
+0

它不會擴展參數列表中的宏嗎? – unwind

+0

謝謝,它的工作原理。我嘗試了'PREDEFINED'和'ENABLE_PREPROCESSING'標籤,但我錯過了'MACRO_EXPANSION'。 – user4780495

+0

@unwind你說得對。修復了答案。謝謝! – manlio