c - Doxygen不会生成功能文档

我正在尝试第一次使用doxygen。

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

我认为使用正确的标签，但是文档仅在涉及到define宏方面才是好的，但是功能标签(\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);

最佳答案

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



因此，只需删除整个\fn行，它就可以工作。

更新:

顺便说一句 \file shouldn't have a filename after it。



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