【问题标题】:Doxygen: \xrefitem command does not work as expectedDoxygen:\xrefitem 命令无法按预期工作
【发布时间】:2019-09-13 11:25:41
【问题描述】:

我尝试使用如doxygen documentation 中所示的\xrefitem 命令

我的 Test.h 文件:

/** @page my_errors My Errors
 *  @brief Errors page
 *
 *  Errors page contents.
 */

/** @error ERROR 101: in case a file can not be opened.
    Check about file system read/write access.*/
#define MY_ERR_CANNOT_OPEN_FILE 101

/** \error ERROR 102: in case a file can not be closed.
    Check about file system read/write access. */
#define MY_ERR_CANNOT_CLOSE_FILE 102

并使用别名:

ALIASES += "error=\xrefitem my_errors \"\" \"\""

页面My Errors 已创建,但两个错误的文档未显示在输出中。我必须添加一些设置吗?

所有其他首选项都是默认设置。 Doxygen 版本是 1.8.16

【问题讨论】:

    标签: doxygen


    【解决方案1】:

    当使用页面顶部的注释/// \file 时,会显示“错误”。 虽然我收到警告:

    my_errors:1: warning: multiple use of page label 'my_errors', (other occurrence: .../aa.h, line: 4)
    

    这不是很好,但不会破坏输出。

    编辑:我刚刚将关于警告的提议补丁推送到 github (https://github.com/doxygen/doxygen/pull/7260)

    【讨论】:

    • 好的,现在定义 1 个作品。但第二个仍然不是 diplaye。我得到错误:test.h:16: warning: documentation for unknown define MY_ERR_CANNOT_CLOSE_FILE found.
    • 当我使用 1.8.16 并将 /// \file 放在 Test.h 的顶部时,我看到了两个定义、它们的文档以及定义和 my_errors 页面。我忽略了什么吗?
    猜你喜欢
    • 2014-11-28
    • 2019-07-31
    • 1970-01-01
    • 2021-05-22
    • 1970-01-01
    • 2012-04-11
    • 2015-06-24
    • 1970-01-01
    • 2010-11-05
    相关资源
    最近更新 更多