CODEWITHSUNDEEP
doxygen
Marc-Christian Schulze
Marc-Christian Schulze

Reputation: 3264

Show undocumented function parameters

I'm using doxygen for generating HTML documentation of a C++ code. Unfortunately doxygen doesn't show undocumented method parameters in the method description. For example, with the following

/**
 * Some method
 * @param p1 Some param
 */
void method(const std::string& p1, const std::string& p2);

the method description will show the comment and the parameter p1 but not p2.

How can I configure doxygen to list all parameters in the method description even if not explicitly documented?

Upvotes: 2

Views: 2847

Answers (1)

doxygen
doxygen

Reputation: 14879

This is not possible.

Doxygen can warn you about incomplete, wrong, or missing parameter documentation though.

The relevant settings are:

WARNINGS          = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC  = YES

Upvotes: 3

Related Questions