C语言 Doxygen不生成函数文档

Question

我是第一次尝试使用doxygen。

我正在使用它来记录一些 C 库和结构。

我认为使用正确的标签，但文档仅在定义宏方面很好，但功能标签（fn）被完全忽略。我在下面附上一个我标记的评论示例：

`/*!    file   cab.h`
    author dan
    date   20/12/2013
    brief  cab
`*/
   /*! def NOT_SPECIFIED`
     brief Constant value that indicates the not specification of a parameter
  ` */`
   `#define NOT_SPECIFIED 0`
    /*! fn         cab_create
     brief     allocates the memory space and resources for the CAB
     param     c cab to create
     param     dim_buf size of the data contained in each buffer
     param     maximum number of buffer
     param     protocol used to handle priority inversion 
     param     ceiling value of the ceiling,
     return    1 if it completes successfully, -1 otherwise
    */`
    int cab_create(cab *c, int dim_buf, int max_buf, int protocol, int ceiling);

Answer 1

文档明确指出，仅当您的注释未放在函数声明之前时，才需要fn。

如果注释块位于函数声明的前面，或者 定义此命令可以（并且为了避免冗余应该）是 省略。

因此，只需删除整条fn行，它应该可以工作。

更新：

顺便说一句，file不应该在它后面有一个文件名。

如果省略文件名（即 \file 后面的行留空） 则包含 \file 命令的文档块将 属于它所在的文件。

如果指定文件名，则必须在文件名更改时手动更新它（这将会发生），并且您可能会忘记这样做。不指定文件名更容易，并且始终是最新的。