Doxygen：显示未记录方法的警告 [英] Doxygen : Display warning for undocumented method

问题描述

我已使用脱氧剂激活警告

i've activated warnings with doxygen

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

但是像这样的无证方法：

But undocumented methods like this one:

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

在产生氧气的过程中不要发出任何警告。
在这种情况下是否有任何显示警告的方法？

Do not throw any warning during doxygen generation. Is there any way to display warning in this situation ?

未记录退货的相同问题，例如

Same problem with undocumented return , for example

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

不对无证退货发出警告

推荐答案

如果缺少本应期望的警告，请检查 EXTRACT_ALL 是否设置为是。

When you are missing warnings that you would otherwise expect, check whether EXTRACT_ALL is set to YES.

从doxyfile的注释版本开始：

From the commented version of the doxyfile:

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

使用全部提取第一次通过或从非过氧化氢源中提取某些东西，但总的来说，最好能够将其关闭，从而能够获得警告，以完善您实际需要记录的零件。

Using EXTRACT ALL can be useful for a first pass or to extract something from a non-doxygenned source, but in general it's a good idea to aim to be able to turn this off and thus be able to get the warnings that refine the parts that you actually need documented.

这篇关于Doxygen：显示未记录方法的警告的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！