8

我有一个函数的 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

但这不起作用。

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

4

2 回答 2

7

如果#自动链接到函数参数定义会很好。但是，我无论如何都看不到在 doxygen 手册的自动链接生成部分中这样做。

查看文档 HTML 源代码后，似乎参数的样式似乎strong与 class一样简单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>"
于 2012-06-19T08:58:20.943 回答
1

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

用于\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特殊命令参考。

于 2017-12-10T23:07:40.320 回答