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

时间:2013-08-06 12:39:09

标签: doxygen

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

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

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

"Related Pages" page, with "Wall of Shame" link. Note the empty description field.

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

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

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

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

1 个答案:

答案 0 :(得分:5)

你可以做到

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

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