Doxygen:宏和枚举元素的自动引用

时间:2014-09-27 20:29:27

标签: c doxygen

我使用doxygen 1.8.8来记录C项目,我将AUTOLINK_SUPPORT设置为YES

说,我有一个像这样记录的宏:

/**
 * My macro
 */
#define MY_MACRO

然后,我在一些函数的注释中提到了这个宏,如下所示:

/**
 * My function uses `MY_MACRO` heavily
 */
void my_func(void) { ... }

在这种情况下,MY_MACRO不是参考。经过大量的实验,我找到了一些方法来制作doxygen以供参考:

  • 像这样指定:\ref MY_MACRO。我不喜欢它,因为(a)在评论中写作和阅读并不方便; (b)字体不是等宽的。我试图将它与反引号结合起来,它不起作用;
  • 像这样指定:MY_MACRO()。我不喜欢它,因为很明显,这些括号表示宏是参数化的,但事实并非如此;
  • 在评论底部指定它,如下所示:@see MY_MACRO。我不喜欢它,因为它不方便阅读,如果内联引用宏会好得多。

那么,如何在函数注释中引用它?

UPD:我的doxyfile:http://vpaste.net/FuIk4

1 个答案:

答案 0 :(得分:0)

正如autolink docs中所述,我们应该使用#预先添加宏名称,枚举项目或枚举名称:

/**
 * My function uses `#MY_MACRO` heavily
 */
void my_func(void) { ... }

然后,MY_MACRO成为链接。