Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

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( )
{
  ...
}

Does not throw warning for undocumented return

like image 646
Mathieu Westphal Avatar asked Jul 07 '14 11:07

Mathieu Westphal


1 Answers

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

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.

like image 151
Cheeseminer Avatar answered Sep 29 '22 08:09

Cheeseminer