我想在显示文本struct.member时“链接”到Doxygen中的结构或结构成员。我的源代码在C中。
例如，假设我在C中具有myStruct类型/结构：
typedef struct
{
int member1;
int member2;
} myStruct;
而且我想在显示文本“ myStruct.member1”的同时在我的Doxygen注释中链接/重定向到myStruct的文档。
函数的示例Doxygen注释：
如果myStruct.member1大于5，您将收到错误代码MEMBER_1_NOT_VALID。
单击“ myStruct.member1”会将我重定向到myStruct的文档。
我知道，如果我只有myStruct，我可以说“ \ ref myStruct”，但是不能执行“ \ ref myStruct.member1”。有谁知道如何使文档参考起作用？
任何帮助表示赞赏！谢谢你。
我认为问题在于您一起定义了类型和结构。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.
* ...
*/
本文收集自互联网，转载请注明来源。
如有侵权，请联系 [email protected] 删除。
我来说两句