前置条件下的Doxygen高亮显示参数
我有一个用于函数的doxygen头,如下所示:前置条件下的Doxygen高亮显示参数,doxygen,Doxygen,我有一个用于函数的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 #g
/** 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
@pre <strong class="paramname">grid1</strong> and
<strong class="paramname">grid2</strong> must be the same size.
但这不起作用
关于如何实现这一点有什么想法吗?如果#
自动链接到函数参数定义,那就太好了。但是,我看不出在doxygen手册的章节中有这样做的必要
查看了文档HTML源代码后,参数似乎被简单地命名为strong
,并使用类paramname
。大概是
@pre #grid1 and #grid2 must be the same size
@pre <strong class="paramname">grid1</strong> and
<strong class="paramname">grid2</strong> must be the same size.
编辑:这可以通过配置文件别名实现
ALIASES += paramname{1}="<strong class="paramname">\1</strong>"
alias+=paramname{1}=“\1”
降落在这里寻找答案,但在别处找到了
用于指示下一个单词是函数参数
当然,您可以使用@
而不是\
/** 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