如何在Doxygen中指定\ xrefitem的描述?

问题描述 投票:4回答:1

我正在使用\xrefitem command创建一组自动交叉引用的用户定义部分。例如,我使用的别名之一如下所示:

hack=\xrefitem hack \"Hack\" \"Wall of Shame\""

这一切都运作良好。我完全按照自己的意愿生成文档,并在“相关页面”页面上显示“羞耻墙”的链接:

但我无法弄清楚如何在此链接的右侧添加说明。那个空的描述单元只是乞求填补。我怎么能让它开心?

虽然文档没有表明这是有效的语法,但我尝试在别名的末尾添加描述,如下所示:

hack=\xrefitem hack \"Hack\" \"Wall of Shame\" \"Some sample descriptive text\""

但它不起作用;它打破了其他一切。

doxygen
1个回答
5
投票

你可以做

/*! @page hack 
 *  @brief Some sample descriptive text.
 *  @par
 */

请注意,不应该需要虚拟@par,但由于doxygen中的逻辑错误,目前需要它,我将在下一个版本中修复它。

© www.soinside.com 2019 - 2024. All rights reserved.