microsoft / vscode-cpptools

Official repository for the Microsoft C/C++ extension for VS Code.
Other
5.4k stars 1.51k forks source link

Not All Doxygen Comment Blocks Supported #12316

Open tristan-smith opened 1 month ago

tristan-smith commented 1 month ago

Environment

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

heartacker commented 1 month ago

praise

sean-mcmanus commented 2 weeks ago

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

tristan-smith commented 2 weeks ago

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