DOXYGEN:创建多参数别名,不带花括号语法,如@param&其他人(标签!)?

时间:2014-07-26 12:00:33

标签: documentation alias doxygen curly-braces

我们使用doxygen来记录我们刚刚开始的项目中的C / C ++代码,如果可能的话,我们希望实现以下目标。 在创建具有多个参数的自定义ALIAS时,我们在代码文档中使用的语法如下所示:

/**
 * @myalias{param1,param2}
 */

在我们的.doxy文件中,此ALIAS的定义如下所示:

ALIASES += myalias{2}="do something with \1 and with \2"

我们想要的是定义一个自定义标记,其行为类似于@param,这将允许我们在记录源文件时使用以下语法:

/**
 * @myalias param1          param2
 */

仍然可以参考param1& param2不知何故。

我知道,例如,@ param标签可以识别param1和amp; param2是2个不同的实体,它不需要任何花括号。

是否可以定义一个自定义标签,我们可以在其中访问param1& param2作为我们的.doxy文件中的单独实体,但是使用没有大括号的代码文档语法?

提前谢谢

1 个答案:

答案 0 :(得分:1)

简短的回答是否定的。在仔细阅读了doxygen文档后,似乎有一个合理的解释为什么。内置的doxygen命令列表可能会发生变化,并且您不希望重新定义所有别名。当发生冲突时,您如何选择命令与别名? doxygen不是必须执行决定,而是强制您指出哪个是哪个。

文档隐含的示例位于aliases with arguments部分。在这里,l{1}别名被定义并进行了详细的实验。但是,如果您转到the bottom of the list of commands,它会明确指出存在永远不应明确使用的命令\l。大括号别名定义使得它完全明确无误使用哪一个。

我不确定这是否真的是一种刻意的设计理念,或者只是以这种方式快乐地聚集在一起,但这种区别是有用的。

我很抱歉写这个答案,因为我自己希望得到你想要达到的结果。知道原因有帮助。