And*_*ier 5 c struct typedef doxygen hyperlink
我在 C 头文件上使用 Doxygen,并且很难将描述文本中出现的 typedef 名称变成指向相应 typedef 定义的链接。这适用于结构,但不适用于 typedef。
例子:
struct _my_s1;
/** Description for typedef my_s1. */
typedef struct _my_s1 my_s1;
struct _my_s2;
/** Description for typedef my_s2. */
typedef struct _my_s2 my_s2;
/**
* @brief Structure _my_s1
*/
struct _my_s1 {
my_s2 * s2t; ///< pointer to my_s2
struct _my_s2 * s2s; ///< pointer to struct _my_s2
/**
* @brief Function f2t
* @param s2t A pointer to my_s2.
* @return An integer.
*/
int (*f2t)(my_s2* s2t);
/**
* @brief Function f2s
* @param s2s A pointer to struct _my_s2.
* @return An integer.
*/
int (*f2s)(struct _my_s2* s2s);
};
/**
* @brief Structure _my_s2
*/
struct _my_s2 {
int a; ///< integer
};
Run Code Online (Sandbox Code Playgroud)
在输出中,my_s2任何描述文本中所有出现的 typedef 名称都变成纯文本。所有出现的都struct _my_s2成为结构定义的链接。
在阅读如何使用 Doxygen 对 typedef 进行分类?后,我添加了 typedef 定义的描述行。 (我推测 Doxygen 可能需要有关于某些内容的文档才能成为链接的目标),但添加描述并没有帮助。
我怎样才能让 Doxygen 创建指向 typedef 的链接,就像它为结构所做的那样?
我在 Ubuntu 14.04 上使用 doxygen 1.8.6。
在上面的示例中运行 doxygen 时,我没有收到任何错误(还有 @file 和 @defgroup,此处未显示)。
安迪