在 doxygen 中添加指向 typedef 的链接
Add links to typedefs in doxygen
在下面的例子中,生成的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);
我描述的一切都按预期工作。
记录我在这里犯的错误以防其他人犯同样的错误。
我的错误是在我的代码库中(不是我在这里展示的示例)我将我的函数与 defgroup 分组在一起,而不是我的类型声明。显然没有围绕类型的 defgroup 允许结构定义仍然可见并链接到 html,但不是其他类型。
在下面的例子中,生成的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);
我描述的一切都按预期工作。
记录我在这里犯的错误以防其他人犯同样的错误。
我的错误是在我的代码库中(不是我在这里展示的示例)我将我的函数与 defgroup 分组在一起,而不是我的类型声明。显然没有围绕类型的 defgroup 允许结构定义仍然可见并链接到 html,但不是其他类型。