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

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手册的自动链接生成部分看到这样做.

看过文档HTML源代码后,似乎参数似乎只是简单地设置为strong类和类paramname.所以像

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

应该给你想要的结果.显然,每次写出都过于冗长.但是,您应该能够定义一个自定义命令,比如说\paramname,这样做就可以了

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

编辑:这可以使用配置文件别名来实现

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