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

【问题标题】：How do you link (reference) a member of a structure using Doxygen?你如何使用 Doxygen 链接（引用）结构的成员？
【发布时间】：2015-11-20 15:56:05
【问题描述】：

我想在显示文本 struct.member 时“链接”到 Doxygen 中的结构或结构成员。我的源代码是 C 语言。

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

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

我想在我的 Doxygen cmets 中链接/重定向到 myStruct 上的文档，同时显示文本“myStruct.member1”

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

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

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

感谢任何帮助！谢谢。

【问题讨论】：

标签： c doxygen

【解决方案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.
 * ...
 */

【讨论】：