【问题标题】:Doxygen : Display warning for undocumented methodDoxygen:显示未记录方法的警告
【发布时间】:2014-07-07 11:32:12
【问题描述】:

我已经用 doxygen 激活了警告

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

但是像这样的无证方法:

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

在 doxygen 生成期间不要抛出任何警告。 在这种情况下有什么方法可以显示警告吗?

同样的问题与无证返回,例如

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

不会对无证退货发出警告

【问题讨论】:

  • 绝对确定包含未记录代码的文件在您的 INPUT 定义范围内吗?
  • 是的,当然,如果我记录这些方法但忘记了参数,这些方法会抛出错误。但我知道我应该有警告?我可以在这里尝试一些最小的测试。
  • 您使用的是 EXTRACT_ALL 吗?是否设置为 YES 会禁用一些警告。
  • 你是对的,谢谢你指出这一点。将其设置为 NO 会为未记录的方法产生警告。
  • 为了完整性添加为“答案”。

标签: documentation warnings doxygen


【解决方案1】:

如果您错过了原本预期的警告,请检查 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 可用于第一次通过或从非 doxygenned 源中提取某些内容,但总的来说,最好能够将其关闭,从而能够获得以下警告细化您实际需要记录的部分。

【讨论】:

    猜你喜欢
    • 2020-12-06
    • 1970-01-01
    • 2015-12-18
    • 2013-06-04
    • 2010-11-03
    • 1970-01-01
    • 1970-01-01
    • 2011-09-14
    • 2015-08-02
    相关资源
    最近更新 更多