在Doxygen中引用模板参数的正确方法是什么?

时间:2016-07-27 14:13:15

标签: c++ templates doxygen

后续问题:

What's the right way to reference a parameter in Doxygen?

因此,对于参数,我们使用@param

@param my_param the quick brown fox takes this parameter over the lazy dog

然后我们可以使用@p来引用它:

@param my_other_param this is completely different from @p my_param , you know!

现在,对于模板参数,我会将@param替换为@tparam。什么应该取代@p

2 个答案:

答案 0 :(得分:4)

@p ""引用"参数;它只是打字机字体中的下一个单词的样式。您通常会使用它来引用参数,但@p除了使用打字机字体用于下一个单词之外没有做任何特别的事情。

因此,如果您愿意,可以使用@p设置模板参数的样式。或者您可以使用@a。或者是其他东西。这完全取决于您希望结果的显示方式。

答案 1 :(得分:-1)

要创建引用另一个符号,请使用@ref命令。但是,此命令不适用于参数。 Doxygen不会将它们识别为@ref的目标。