Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
spe-ciellt opened this issue Feb 15, 2023 · 0 comments
Open

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

spe-ciellt opened this issue Feb 15, 2023 · 0 comments
Labels

Comments

@spe-ciellt
Copy link

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 spe-ciellt added the bug label Feb 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant