Doxygen doesn't warn for missing parameter if none is already documented

时间:2016-11-26 18:43:09

标签: c++ doxygen

If I write this (in the class CPosition, file position.h):

/**
 * @brief Constructor
 * @param x x coordinate
 */
CPosition(int x, int y);

Doxygen warns me:

error: The following parameters of CPosition::CPosition(int x, int y) are not documented:
parameter 'y'

But if no parameter is documented in the CPosition constructor, like this:

/**
 * @brief Constructor
 */
CPosition(int x, int y);

Doxygen doesn't warn me at all.

What configuration am I missing if I want doxygen to warn even if no parameter is already documented ?


Some relevant configuration directives of my Doxyfile:

WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = YES

0 个答案:

没有答案