Question

全部，

我正试图处理doxygen标签，并遇到了以下'问题' 在下面显示的代码中，如果从第二行删除@file doxytest.c，一切都很好。但是，如果我保留它，输出日志包含：

/Users/bp/learn/gendoxy/gendoxy/doxytest.c:10：警告：在foobar0（int文件夹）的参数列表中找不到命令@param的参数'int' /Users/bp/learn/gendoxy/gendoxy/doxytest.c:10:warning：未记录foobar0（int文件夹）的以下参数：参数'folder'

这对我来说没有意义（应该吗？）这是在'.c'文件中，在MacOS上运行。
我究竟做错了什么？ - 我想要@file标签，没有来自doxygen的警告/错误。

或者，喘气！，这是一个错误吗？

/*!
 *  @file doxytest.c
 *
 *  @author bp 
 *  @version 0.0.1
 *  @copyright (2013) we be nerds,LLC 
 */

 /*!  
  *   @brief  void foobar0 ( int folder )
  *     does little to better the world.
  *
  *   @param [in] int folder :- one small step
  *
  */

  void foobar0 ( int folder )
  {
    for (int ii = 0; ii < folder; ii++)
    {
        foobar1( ii );
    }
}


/*!
 * @brief foobar2  ( int x )
 * does half of what foobar1 does.
 *
 */

void foobar1( int x )
{
    return( x /2 );
    }

Answer 1

不要在doxygen注释中包含变量类型

  *   @param [in] folder :- one small step

否则它认为你记录变量'int'，它也认为你忘了记录变量'folder'。

所以是的，你应该保留@file标签。老实说，我发现删除@file标签会使警告消失，这很奇怪。

doxygen @param被@file标记弄糊涂了

1 个答案: