doxdocgen icon indicating copy to clipboard operation
doxdocgen copied to clipboard

Multiple return types should use @retval, not @return

Open spe-ciellt opened this issue 2 years ago • 0 comments

Describe the bug Multiple return types (typically bool) should use @retval, not @return.

Code example

/**
 * @brief
 *
 * @return true
 * @return false
 */
bool some_function(void);

Expected result

/**
 * @brief
 *
 * @retval true
 * @retval false
 */
bool some_function(void);

Actual result

/**
 * @brief
 *
 * @return true
 * @return false
 */
bool some_function(void);

Your System:

  • OS: Linux
  • VS Code Version: 1.75.1
  • Doxdocgen Code Version: 1.4.0

spe-ciellt avatar Feb 15 '23 15:02 spe-ciellt