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 comment tags aren't ended after a blank line #5903

Closed
sean-mcmanus opened this issue Aug 5, 2020 · 7 comments
Closed

Doxygen comment tags aren't ended after a blank line #5903

sean-mcmanus opened this issue Aug 5, 2020 · 7 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

@sean-mcmanus
Copy link
Contributor

sean-mcmanus commented Aug 5, 2020

Use code

/**
 * @brief Shuffle vector.
 * @return Nothing.
 * 
 * Details...
 */
void shuffle(std::vector<int> &v);

Hover over shuffle.

The "Details..." comment is incorrectly combined with the Nothing comment.

The issue repros with doxgyen comments in the gcc headers.

A bug on VS is filed at https://developercommunity.visualstudio.com/content/problem/1137513/doxygen-comment-tags-arent-ended-after-a-blank-lin.html

@sean-mcmanus sean-mcmanus added Language Service Visual Studio Inherited from Visual Studio Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. labels Aug 5, 2020
@sean-mcmanus sean-mcmanus added this to the Tracking milestone Aug 5, 2020
@sean-mcmanus sean-mcmanus added the more votes needed Issues that have been postponed until more community members upvote it label Jul 3, 2021
@michelleangela
Copy link
Contributor

michelleangela commented Nov 9, 2021

This might be a duplicate of #5741 which just got fixed for Visual Studio.

@sean-mcmanus
Copy link
Contributor Author

It's not fixed...it might have been improved via add a whitespace though. They closed it as low pri.

image

@sean-mcmanus sean-mcmanus removed this from the 1.8.0-insiders2 milestone Nov 24, 2021
@bobbrow bobbrow added this to the Tracking milestone Jan 18, 2022
@bobbrow bobbrow added bug and removed more votes needed Issues that have been postponed until more community members upvote it labels Mar 12, 2022
@0Grit
Copy link

0Grit commented Aug 11, 2023

I'm not sure how this doesn't bother more people.

@Mode-77
Copy link

Mode-77 commented Jan 10, 2024

I'm not sure how this doesn't bother more people.

It is very frustrating.

@Mode-77
Copy link

Mode-77 commented Jan 10, 2024

The closest mechanism to a solution for this issue is to use the @details or \details marker after adding details to the supported tags in the settings. After you do this, the text will have its own section like the others. See #11842.

image

@tueda
Copy link

tueda commented Nov 15, 2024

Seems to have been fixed.

  • VS Code Version: 1.95.2
  • C/C++ Extension Version: 1.22.11

@sean-mcmanus sean-mcmanus added the fixed Check the Milestone for the release in which the fix is or will be available. label Nov 15, 2024
@sean-mcmanus sean-mcmanus modified the milestones: Tracking, 1.22 Nov 15, 2024
@sean-mcmanus sean-mcmanus moved this to Done in cpptools Nov 15, 2024
@sean-mcmanus
Copy link
Contributor Author

@tueda Yeah, I see it fixed too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Status: Done
Development

No branches or pull requests

6 participants