如何在Doxygen中为\xrefitem指定描述？

Question

6

我正在使用\xrefitem命令创建一堆自定义部分，这些部分都会自动交叉引用。例如，我使用的一个别名如下:

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

这一切都很好运作。文档的生成方式完全符合我的要求，在“相关页面”上出现了指向“Wall of Shame”的链接：

但是我不知道如何在这个链接右侧添加描述。那个空的描述单元格就像在等着填充。我该如何让它满意呢？

虽然文档没有说明这是有效的语法，但我尝试将描述附加到别名末尾，像这样：

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

但它并没有起作用，反而破坏了其他一切。

- Cody Gray

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- doxygen · Accepted Answer

您可以做到

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

请注意，虚拟的@par本不是必需的，但由于doxygen中的逻辑错误，目前仍需要使用它。我将在下一个版本中修复这个问题。