2014-11-24 72 views
0

我想使用doxygen來記錄類似c的語言。 我得到了一些問題來解決上下文中未知的關鍵字。Doxygen:添加新類型或結構

一個例子,我必須使用所謂的

on timer 
{ 
    //normal c- code 
} 

我想問一個回調函數現在,我可以採取的doxygen接受新的關鍵字? 我想添加這個關鍵字就像一個函數或變量acc。到

/** This timer is used for something. */ 
on timer 
{ 
} 

也許

/** \ontimer This timer is used for something. */ 
on timer 
{ 
} 

的doxygen的文檔描述了帶有別名東西或\ xrefitem但據我所知,我只能產生新的章節已知類型還是我錯了? 其實我用一個條件塊來包圍未知代碼,以避免生成輸出中的錯誤。

回答

0

據我所知,是「關於」doxygen無法解釋的關鍵字。一種解決方案可能是通過使用該PREDEFINED標籤如下聲明關鍵字on作爲doxyile一個predfined宏:

PREDEFINED    = on= 

是的,=末是不是一個錯字!這告訴doxygen的預處理器用空字符串替換關鍵字on。請注意,您必須將ENABLE_PREPROCESSING設置爲YES

如果on關鍵字只有之前的回調函數出現,你可以或者設置PREDEFINEDvoid

PREDEFINED    = on=void