将Doxygen链接类型设置为C文件

时间:2014-12-02 20:24:00

标签: 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放在文档中听起来会更好,但不能链接到有用的地方。

1 个答案:

答案 0 :(得分:0)

虽然它有点冗长,但这就是我想要的:

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