有Doxygen链接类型为文件C

问题描述：

我在C中创建一个模块。当我在文档中引用该模块时，我想链接到头文件，而不是结构（因为函数和其他有用的信息处于文件级别）。有Doxygen链接类型为文件C

文件my_iterator.h包含

typedef struct { 
    int foo; 
    int bar; 
    } my_iterator_t;

我想my_iterator引用创建一个链接到my_iterator.h。例如，

/** 
    Create a new, specially configured my_iterator 
*/ 
my_iterator_t* special_factory_in_another_module();

把“my_iterator.h”的文件将创建正确的链接，但会听起来很奇怪。将my_iterator_t放在文档中听起来会更好，但不会链接到有用的地方。

我的印象中，你正在尝试这一轮做了错误的方式。我会标记所有属于API的函数，以使用'my_iterator_t'和'@ related'或'@ memberof'标记。 – 2014-12-02 22:20:28

感谢您的建议;它几乎奏效。问题在于\关系只适用于类。所以，我可以将函数“关联”到my_iterator_t;但是将函数与“class”my_iterator_t放在一起，而不是文件my_iterator.h（其中记录了其余函数）。 – Zack 2014-12-18 19:34:15

答

虽然这是一个有点冗长，这做什么，我想：

/** 
* Create a new, specially configured [my_iterator](@ref my_iterator.h) 
*/ 
my_iterator_t* special_factory_in_another_module();