1

全部，

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

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

这对我来说毫无意义（应该吗？）这是在一个“.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 );
    }
4

1 回答 1

2

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

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

否则，它认为您记录了变量“int”，并且还认为您忘记记录变量“文件夹”。

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

于 2013-10-08T05:29:09.270 回答