没有“list title”参数的doxygen别名xrefitem?

时间:2017-11-21 07:03:50

标签: doxygen

我正在准备使用doxygen的C代码的代码文档。 我想在输出rtf文档中的每个函数的Parameters和Returns部分下创建一个Errors部分。

/**
 * Some description
 *
 * @param[in]      i4InputParam
 *
 * @error IOError
 * @error RangeError
 */

在在线doxygen手册中,我为此找到了\xrefitem命令。 在我的doxygen配置文件中,我有@error标签的以下别名定义:

ALIASES += error="\xrefitem @error \"Errors\" \"Errors\""

此别名会根据需要在函数文档中创建“错误”部分。但是,它还会在TOC之后和文件索引部分之前创建错误列表部分。我不想要这个顶级错误列表部分。

问题是“list title”参数似乎是强制性的。 当我删除第三个参数时,它不会创建那些错误部分。当我设置为空\“\”时,它仍会创建顶级错误列表。

您是否有任何建议迫使\ xrefitem忽略“list title”参数?或者您是否建议执行此操作的其他替代方法?

0 个答案:

没有答案