在 doxygen 中记录 C typedef

Question

按照doxygen手册中的例子，我构造了测试头test.h：

/**
 * @file test.h
 */

  /** @brief This is a struct 
   *  @var foo A foo.
   *  @var bar Also a Foo.
   *  @var baz (unused field)
   */
  typedef struct {
     int foo;
     int bar;
     char *baz;
  } whatsit;

当我使用默认 Doxyfile（使用“doxygen -g”生成）时，我看到了警告：

...test.h:11：警告：没有记录复合内容

...test.h:7: 警告：记录的符号 `foo A Foo` 未定义

...test.h:12: 警告：whatsit 类的成员 foo（变量）没有记录

什么给了？我从手册中得到的印象是，当注释直接位于定义之前时，您不需要像 @struct 这样的标签，而且在上面的块中记录成员变量是合法的，而不是在它们的同一行上用/*< ... 语法声明。 （我绝对讨厌后一种风格……）

我怎样才能让它正确识别评论？

Answer 1

根据文档： 24.51 \var（变量声明）

表示注释块包含变量或枚举值的文档（全局或作为类的成员）。此命令等效于 \fn、\property 和 \typedef。

表示在 \var 行中只有变量的名称应该驻留。由于变量foo 不存在，但结构成员whatsit::foo 您必须使用完整的限定名称。

结构的类似推理。

结果应该是这样的：

/**
 * @file test.h
 */

  /** @struct whatsit
   *  This is a struct
   *
   *  @var whatsit::foo
   *    A foo.
   *  @var whatsit::bar
   *    Also a Foo.
   *  @var whatsit::baz
   *    (unused field)
   */
  typedef struct {
     int foo;
     int bar;
     char *baz;
  } whatsit;