Doxygen中如何在前置条件中高亮显示参数

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

但是这样做不起作用。 你有什么想法如何实现这个？

- Richard

Answer 1

如果#自动链接到函数参数定义，那将会很好。然而，在doxygen手册的自动生成链接部分中，我无法找到任何实现这一点的方法。

查看文档HTML源代码后，似乎参数只是简单地用标签进行样式处理，并使用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>"

- Chris

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 特殊命令参考。保留html，不进行解释。

- user7502825