问题
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
回答1:
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.
来源:https://stackoverflow.com/questions/24609599/doxygen-display-warning-for-undocumented-method