你如何使用 Doxygen link (reference) 结构的成员？

Question

我想在显示文本 struct.member 时 "link" 到 Doxygen 中的结构或结构成员。我的源代码在 C.

例如，假设我在 C:

中有 myStruct type/structure

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

而且我想 link/redirect 在我的 Doxygen 评论中对 myStruct 上的文档进行显示，同时显示文本 "myStruct.member1"

函数的 Doxygen 注释示例：
如果 myStruct.member1 大于 5，您将收到错误代码 MEMBER_1_NOT_VALID。

点击 "myStruct.member1" 将我重定向到 myStruct 的文档。

我知道如果我只有 myStruct，我可以说“\ref myStruct”，但是做“\ref myStruct.member1”是行不通的。有谁知道如何使文档引用起作用？

感谢任何帮助！谢谢。

Answer 1

我认为问题是你把类型和结构定义在一起了。 Doxygen 的解析器似乎对结构和类型定义的混合声明有问题。尝试分别定义结构体和类型定义：

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.
 * ...
 */

How do you link (reference) a member of a structure using Doxygen?