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

Method documentation snippet has all text crammed together so it is unintelligible #330

Open
kenkopelson opened this issue Nov 28, 2023 · 1 comment
Labels

Comments

@kenkopelson
Copy link

Describe the bug
When you hover over a method, the documentation for that method shows, but the @brief, extra lines, @code, etc. are all crammed together in one blob of text. This must be a bug, since the comment is virtually useless if no formatting or whitespace separation is present.

Code Example

/**
 * @brief This is the summary
 *
 * This is continued documentation, which is formatted with blank lines between sections
 *
 * @code
 * print("this is a string");
 * int i = 0;
 * @endcode
 */

Expected result

void ArmSolver::setArmBase(Position *armBase)
This is the summary

This is continued documentation, which is formatted
with blank lines between sections

print("this is a string");
int i = 0;

Parameters:
armBase

Actual result

void ArmSolver::setArmBase(Position *armBase)
This is the summary This is continued documentation, which is formatted with blank lines between sections print("this is a string") int i = 0;

Parameters:
armBase

Your System:

  • OS: Windows 10
  • VS Code Version 1.84.2
  • Plugin 1.4.0
@GwnDaan
Copy link

GwnDaan commented Dec 9, 2023

This extension doesn't provide the hover information. It's a bug inside the cpptools extension of vscode microsoft/vscode-cpptools#10039. The doxygen itself is perfectly fine:
image

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

2 participants