6

我第一次尝试使用 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);
4

1 回答 1

10

文档清楚地表明，\fn仅当您的注释未立即放在函数声明之前时才需要这样做。

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

所以只需删除整\fn行，它应该可以工作。

更新：

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

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

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

于 2013-12-30T15:52:32.320 回答