Question

我有一个函数的doxygen标题如下：

/** Some description.

    @param[in]  grid1      First grid
    @param[in]  grid2      Second grid

    @pre grid1 and grid2 must be of the same dimensions
*/

我希望在生成的文档的前置条件部分中特别突出显示grid1和grid2，因为它们是参数。在我看来，我应该能够做一些像

这样的事情

@pre #grid1 and #grid2 must be the same size

但这不起作用。

有关如何实现这一目标的任何想法？

Answer 1

如果#自动链接到函数参数定义，那将会很好。但是，我无法在doxygen手册的automatic link generation部分看到这样做。

查看了文档HTML源代码后，似乎参数似乎只是简单地设置为strong和类paramname。像

这样的东西

@pre <strong class="paramname">grid1</strong> and
    <strong class="paramname">grid2</strong> must be the same size.

应该给你想要的结果。显然，每次写出都过于冗长。但是，你应该能够定义一个custom command，比如\paramname来做这个，这样你就可以写了

@pre \paramname{grid1} and \paramname{grid2} must be the same size.

编辑：这可以使用配置文件别名

来实现

ALIASES += paramname{1}="<strong class="paramname">\1</strong>"

Answer 2

登陆这里寻找答案，但在其他地方找到了。

使用\p表示下一个单词是函数参数。

当然，您可以使用@代替\。

/** Some description.

    @param[in]  grid1      First grid
    @param[in]  grid2      Second grid

    @pre @p grid1 and @p grid2 must be of the same dimensions
*/

参见Doxygen Special Commands reference。

在前提条件下强氧突出参数

2 个答案: