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

Question

6

我希望能够在Doxygen中链接到一个结构或结构的成员，同时显示文本 struct.member。我的源代码是用C编写的。

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

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

我希望在我的Doxygen注释中链接/重定向到myStruct文档，并显示文本“myStruct.member1”。

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

单击“myStruct.member1”将使我重定向到myStruct的文档。

我知道如果只有myStruct，我可以说“\ ref myStruct”，但是使用“\ ref myStruct.member1”无效。有人知道如何使文档引用起作用吗？

感谢您提供任何帮助！谢谢。

- rose

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- gmug · Accepted Answer

我认为问题在于您将类型与结构一起定义。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.
 * ...
 */