2011-03-08 27 views
8

我想在Doxygen中創建類似於\fn\param\var的自定義命令。創建新的自定義命令,將添加到Doxygen中的部分

例如我想能夠創建一個\option命令,我會使用如下:

/** 
    \option option_1 This is the first option. 
    \option option_2 This is the second option. 
*/ 

有了這樣的輸出:

        選項:
                option_1這是第一個選項。
                option_2這是第二個選項。




一個簡單的替換別名不起作用。例如這個別名:

ALIASES = option="\par Options:\n" 

我得到以下輸出:

        選項:
                option_1這是第一個選項。

        選項:
                option_2這是第二個選項。

這不是我正在尋找的。


BOUNTY:

如果需要任何進一步的說明,請參閱我的問題:Doxygen - Create custom command

回答

3

雖然它不像@param那麼幹淨,但您可以使用以下別名來模擬類似的行爲:

ALIASES += options="<dl class="params"><dt>Options</dt><dd><table class="params">" 
ALIASES += option{2}="<tr><td class="paramname">\1</td><td>\2</td></tr>" 
ALIASES += endoptions="</table></dd></dl>" 

別名可用於如下產生你要找的輸出:

/** 
* @options 
* @option{ option_1, This is the first option. } 
* @option{ option_2, This is the second option. } 
* @endoptions 
*/ 

注:這是HTML爲中心,可能不會產生其他格式的合理輸出。

0

看起來xrefitem可能做你想要的東西在這個前面的問題回答說: Custom tags with Doxygen

+1

該命令的作用是爲給定命令創建單獨的頁面並創建指向該頁面的鏈接。方法文檔的輸出與我的簡單別名大致相同。絕對不是我在找的東西。 – amicitas 2011-03-08 02:21:32

相關問題