Doxygen: displaying a warning for an undocumented method

I activated alerts with doxygen

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

But undocumented methods like this:

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

Do not throw warnings while generating doxygen. Is there a way to display a warning in this situation?

A similar problem with undocumented returns like

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

Does not throw a warning for undocumented returns

+4
source share
1 answer

If you do not have enough warnings that you would otherwise expect, check if it is set EXTRACT_ALLto YES.

From a commented version of doxyfile:

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

EXTRACT ALL - , , , , , , , .

+5

Source: https://habr.com/ru/post/1547399/


All Articles