Doxygen:显示未记录方法的警告

时间:2014-07-07 11:32:12

标签: documentation warnings doxygen

我用doxygen激活了警告

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

但是像这样的未记录的方法:

void AnimationManager::setAnimationTimeStep( double timeStep )
{
  ...
}

在氧气生成过程中不要发出任何警告。 在这种情况下有没有办法显示警告?

与未记录的返回相同的问题,例如

/**
 * @brief brief description
 */
bool AnimationManager::hasAnimationTimeStep( )
{
  ...
}

不会针对无证件返回发出警告

1 个答案:

答案 0 :(得分:8)

当您缺少预期的警告时,请检查EXTRACT_ALL是否设置为YES

来自doxyfile的注释版本:

# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.

使用EXTRACT ALL对于第一次传递或从非强化源中提取某些内容非常有用,但一般来说,最好能够将其关闭,从而能够获得警告,细化您实际需要记录的部分。