使用doxygen

Question

正如标题所示，我想为Subversion中管理的C项目强制执行源代码文档。

我的想法是：设置一个预提交钩子，使用doxygen来检查带有这个选项的文件

   WARNINGS              = YES
   WARN_IF_UNDOCUMENTED  = YES
   WARN_IF_DOC_ERROR     = YES
   WARN_NO_PARAMDOC      = YES

问题是：为了让doxygen考虑源文件并为未记录的成员发出警告，似乎我必须将“\ file”文档块放入该文件中，如下所示。

/** \file foo.h
 * A file for testing how to enforce documentation
 *
 * if I don't put voluntarily this first "file" block, 
 * doxygen "ignores" the file and does not generate the warnings
 * I would expect (note that otherfunction is not documented)
 */


#ifndef FOO_H_
#define FOO_H_


/**
* \brief my test function 
* \param msg a simple string
* \return 0 if ok, 1 if not ok
*/
int testFunction(const char *msg);



int otherFunction(const char *msg);

#endif

如果我没有doxygen“忽略”该文件，则不会发出警告。 这使得检查失效：用户很容易忘记将所需的块放在源的开头并在没有控制的情况下提交。

有没有办法让doxygen强制执行文件开头的/ file块？