cschlosser / doxdocgen

Generate doxygen documentation from source code in VS Code
https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen
MIT License
258 stars 54 forks source link

Multiple return types should use @retval, not @return #311

Open spe-ciellt opened 1 year ago

spe-ciellt commented 1 year ago

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: