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