Doxygen - 创建自定义命令

时间:2011-08-08 16:00:07

标签: command arguments doxygen param

我认为我的问题与此问题基本相同,但没有得到一个好的答案:Create new custom command that will add to a section in Doxygen

我认为,我非常想做同样的事情。我想完全复制@param选项的确切功能,除了给它标题“Options”而不是“Parameters”。我希望参数是相同的(数据类型,变量名称和描述),并希望它们看起来完全相同和一切。从字面上看,我唯一需要的是标题。

我也试过这样做:

ALIASES = option"\par Options:\n"

在我的Doxyfile中,但我也在自己的部分中获取每个选项,而不是所有选项都在同一部分中。它们也没有与@param选项相同的参数。

我还尝试用\xrefitem做一些事情,当然,这不起作用。我试过这个:

ALIASES = option="\xrefitem param \"Option\" \"Options\" "

但看起来\xrefitem用于创建更像是来自不同部分的编译列表,例如Todo列表。

非常感谢帮助。谢谢!

<小时/> 修改:

为了澄清一下,我正在寻找的输出看起来像这样:

选项:
string $ option1 这是选项1.
string $ option2 这是选项2.

2 个答案:

答案 0 :(得分:0)

我很确定如果不修改doxygen,这是不可能的。我只是使用\ li并列出使用\ param的选项。

http://www.doxygen.nl/manual/commands.html#cmdli

答案 1 :(得分:0)

我能想出的最接近的是使用它:

@par Options:
@li @e string @b $option1 This is option 1.
@li @e string @b $option2 This is option 2.

这几乎可以正常工作,除了它没有很好地排列每个部分,就像它与@param一样。因此,如果第一个选项的名称类似于$option1而第二个选项的名称是$thisIsTheSecondOption,则说明的开头将不会排列。它看起来更像是:

选项:
string $ option1 这是选项1.
int $ thisIsTheSecondOption 这是选项2.

这使得阅读起来更加困难。

: - \