【问题标题】:Add links to typedefs in doxygen在 doxygen 中添加指向 typedef 的链接
【发布时间】:2020-09-26 00:32:44
【问题描述】:

在以下示例中,生成的 doxygen 文件只会将#mystruct 和 mystruct 转换为指向 mystruct 定义的链接。无论如何,mytype、myenum 和 FIRST_ELEMENT 是否有相同的行为,还是 doxygen 的固有限制?

typedef enum myenum {
  FIRST_ELEMENT,  /**< Some example. */
  SECOND_ELEMENT,  /**< Some other example. */
} myenum;

typedef int16_t mytype;  /**< some example */

typedef struct mystruct {
    mytype x;   /**< my member */
} mystruct;


/**
 * @brief       My test function.
 *
 * This function uses #mytype, #mystruct and #myenum.
 *
 * @param[in]   x   input 1.
 * @param[in]   y   input 2.
 * @param[in]   z   input 3 expected to be #FIRST_ELEMENT.
 */
void foo(mytype x, mystruct y, myenum z);

【问题讨论】:

  • 我试过了(只在文件开头添加/** \file */),所有指向mytype、myenum 和FIRST_ELEMENT 的链接都出现了。这是 doxygen 1.8.17。
  • 是的,这是我的错误:发生的事情是我将函数与 defgroup 组合在一起,而不是我的类型声明。显然没有围绕类型的 defgroup 允许结构定义仍然可见并链接到 html,但不是其他类型。

标签: c doxygen


【解决方案1】:

我所描述的一切实际上都按预期工作。

记录我在这里犯的错误,以防其他人也犯同样的错误。

我的错误是在我的代码库中(不是我在这里展示的示例)我将函数与 defgroup 组合在一起,而不是我的类型声明。显然没有围绕类型的 defgroup 允许结构定义仍然可见并链接到 html,但不是其他类型。

【讨论】:

    猜你喜欢
    • 2015-06-15
    • 2013-03-29
    • 2021-01-28
    • 1970-01-01
    • 2012-09-10
    • 2015-01-17
    • 2014-10-18
    • 2016-06-21
    相关资源
    最近更新 更多