我是第一次尝试使用doxygen.
我正在使用它来记录一些C库和结构.
我认为使用正确的标签,但文档只是涉及到定义宏,但函数tags(\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);
liberforce.. 10
文档明确指出,\fn
只有在您的功能声明之前没有发表评论时才需要这样做.
如果您的注释块位于函数声明或定义的前面,则可以省略此命令(并避免冗余).
所以只需删除整\fn
行,它应该工作.
更新:
顺便说一句,之后\file
不应该有文件名.
如果省略文件名(即\ file保留为空后的行),则包含\ file命令的文档块将属于它所在的文件.
如果指定文件名,则必须手动更新文件名,如果文件名发生变化(这会发生),您可能会忘记这样做.不指定文件名更容易,并且始终是最新的.
文档明确指出,\fn
只有在您的功能声明之前没有发表评论时才需要这样做.
如果您的注释块位于函数声明或定义的前面,则可以省略此命令(并避免冗余).
所以只需删除整\fn
行,它应该工作.
更新:
顺便说一句,之后\file
不应该有文件名.
如果省略文件名(即\ file保留为空后的行),则包含\ file命令的文档块将属于它所在的文件.
如果指定文件名,则必须手动更新文件名,如果文件名发生变化(这会发生),您可能会忘记这样做.不指定文件名更容易,并且始终是最新的.