2011-03-08 28 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

相关问题