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

Not All Doxygen Comment Blocks Supported #12316

Closed
tristan-smith opened this issue May 17, 2024 · 3 comments
Closed

Not All Doxygen Comment Blocks Supported #12316

tristan-smith opened this issue May 17, 2024 · 3 comments
Assignees
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
Projects
Milestone

Comments

@tristan-smith
Copy link

Environment

  • OS and Version: Windows 10
  • VS Code Version: 1.88.1
  • C/C++ Extension Version: v1.20.5
  • If using SSH remote, specify OS of remote machine:

Bug Summary and Steps to Reproduce

Bug Summary:
My work's coding style guide specifies this format of Doxygen comment (No.4 on this page: Doxygen Documentation):

/***************************************************************************//**
* Example Code Block
*
*******************************************************************************/

Note the two forward slashes in the first line.

The VSCode C/C++ Extension doesn't seem to pick this up as a Doxygen comment:

Example with slashes:
image

Example without slashes:
image

Steps to reproduce:

  1. Create a comment block like the above example.
  2. I also attached test.txt with the two examples.
    test.txt

Expected behavior:
I would expect any code block format specified on the Doxygen documentation to render properly like the second screenshot above.

Let me know if I can provide any other info! Thanks for your time and help with this.

Configuration and Logs

{
    "configurations": [
        {
            "name": "Win32",
            "includePath": [
                "${workspaceFolder}/**"
            ],
            "compileCommands": "${workspaceFolder}/build/compile_commands.json",
            "defines": [
                "_DEBUG",
                "UNICODE",
                "_UNICODE"
            ],
            "cStandard": "c17",
            "cppStandard": "c++17",
            "configurationProvider": "ms-vscode.cmake-tools"
        }
    ],
    "version": 4
}

Other Extensions

I also have CMake and NRF extensions installed.

Additional context

No response

@browntarik browntarik added bug Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. Language Service labels May 20, 2024
@browntarik browntarik self-assigned this May 20, 2024
@browntarik browntarik added this to Triage in 1.21 via automation May 20, 2024
@browntarik browntarik moved this from Triage to To do in 1.21 May 20, 2024
@browntarik browntarik moved this from To do to In progress in 1.21 May 28, 2024
@browntarik browntarik moved this from In progress to Pull Request in 1.21 May 29, 2024
@browntarik browntarik moved this from In progress to Pull Request in 1.21 May 29, 2024
@browntarik browntarik moved this from In progress to Pull Request in 1.21 May 29, 2024
@heartacker
Copy link

praise

@sean-mcmanus sean-mcmanus added this to the 1.21.0 milestone Jun 3, 2024
@browntarik browntarik added fixed Check the Milestone for the release in which the fix is or will be available. labels Jun 3, 2024
@browntarik browntarik moved this from Pull Request to Done in 1.21 Jun 3, 2024
@browntarik browntarik moved this from Pull Request to Done in 1.21 Jun 3, 2024
@browntarik browntarik moved this from Pull Request to Done in 1.21 Jun 3, 2024
@bobbrow bobbrow modified the milestones: 1.21.0, 1.21 Jun 17, 2024
@sean-mcmanus
Copy link
Collaborator

@tristan-smith Fixed with https://github.com/microsoft/vscode-cpptools/releases/tag/v1.21.0

@tristan-smith
Copy link
Author

Amazing, thank you @browntarik @bobbrow @sean-mcmanus !! Really appreciate the work.

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
Projects
Status: Done
1.21
Done
Development

No branches or pull requests

5 participants