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

Doxygen multiple returns: only the first return is displayed. #9316

Closed
H-G-Hristov opened this issue May 16, 2022 · 2 comments
Closed

Doxygen multiple returns: only the first return is displayed. #9316

H-G-Hristov opened this issue May 16, 2022 · 2 comments
Labels
bug Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. fixed Check the Milestone for the release in which the fix is or will be available. Language Service Visual Studio Inherited from Visual Studio
Milestone

Comments

@H-G-Hristov
Copy link

Environment

Doxygen supports multiple returns:

\return { description of the return value }

Starts a return value description for a function. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent \return commands will be joined into a single paragraph. The \return description ends when a blank line or some other sectioning command is encountered. See section \fn for an example.

So in case of:

* @return true is good
* @return false is bad

VSCode's documentation popup displays just the first value

Bug Summary and Steps to Reproduce

Create a documentation comment such as:

/** @brief Func
 *
 * @return true
 * @return false
 */
bool ThisIs() { ...};

### Debugger Configurations

```shell
none

Debugger Logs

none

Other Extensions

No response

Additional Information

No response

@sean-mcmanus sean-mcmanus self-assigned this May 16, 2022
@sean-mcmanus sean-mcmanus added bug Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. Language Service Visual Studio Inherited from Visual Studio labels May 16, 2022
@sean-mcmanus sean-mcmanus added this to the Tracking milestone May 16, 2022
@sean-mcmanus
Copy link
Collaborator

Thanks for reporting this. I've filed a bug on VS (shared implementation) at https://developercommunity.visualstudio.com/t/C-Doxygen-comments-only-show-1-return-/10043754 .

@sean-mcmanus sean-mcmanus removed their assignment May 16, 2022
@sean-mcmanus sean-mcmanus modified the milestones: Tracking, 1.11 May 23, 2022
@sean-mcmanus sean-mcmanus added the fixed Check the Milestone for the release in which the fix is or will be available. label May 23, 2022
@sean-mcmanus sean-mcmanus modified the milestones: 1.11, 1.11.0 Jun 8, 2022
@sean-mcmanus
Copy link
Collaborator

This is fixed with 1.11.0 (pre-release).

@github-actions github-actions bot locked and limited conversation to collaborators Sep 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. fixed Check the Milestone for the release in which the fix is or will be available. Language Service Visual Studio Inherited from Visual Studio
Projects
None yet
Development

No branches or pull requests

2 participants