如何使用Doxygen链接（引用）结构成员？

Question

我想＆＃34;链接＆＃34;在显示文本struct.member时，在Doxygen中的结构或结构成员。我的源代码在C。

例如，假设我在C中有myStruct类型/结构：

typedef struct
{
    int member1;
    int member2;
} myStruct;

我希望在显示文本＆＃34; myStruct.member1＆＃34;

功能的Doxygen评论示例：
如果myStruct.member1大于5，您将收到错误代码MEMBER_1_NOT_VALID。

点击＆＃34; myStruct.member1＆＃34;将我重定向到myStruct的文档。

我知道，如果我只是拥有myStruct，我可以说＆＃34; \ ref myStruct＆＃34;，但是做了＃34; \ ref myStruct.member1＆＃34;不起作用。有谁知道如何使文档参考工作？

任何帮助表示赞赏！谢谢。

Answer 1

我认为问题在于您一起定义了类型和结构。 Doxygen的解析器似乎在结构和typedef的混合声明中存在问题。尝试单独定义结构和类型定义：

struct myStruct_s
{ 
    int member1;
    int member2;
};

typedef struct myStruct_s myStruct;

您可以使用类似于您已尝试的结构的标记名称来引用结构成员：

/**
 * ...
 * You will receive the error code MEMBER_1_NOT_VALID if \ref myStruct_s.member1 
 * is larger than 5.
 * ...
 */