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

Description hover do not process '//=====' template #12958

Open
dpasukhi opened this issue Nov 12, 2024 · 1 comment
Open

Description hover do not process '//=====' template #12958

dpasukhi opened this issue Nov 12, 2024 · 1 comment
Labels
bug Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. Language Service Works in VS So we'd need to fix it for VS Code to reach parity.

Comments

@dpasukhi
Copy link

Environment

  • OS and Version: Any
  • VS Code Version: 1.96
  • C/C++ Extension Version: 1.3.0
  • If using SSH remote, specify OS of remote machine:

Bug Summary and Steps to Reproduce

Bug Summary:
Incorrect processing of comment in the next template:

//=======================================================================
// function : Save
// purpose  :
//=======================================================================
TCollection_AsciiString DE_Wrapper::Save(const Standard_Boolean theIsRecursive,
                                         const TColStd_ListOfAsciiString& theFormats,
                                         const TColStd_ListOfAsciiString& theVendors)
{

The result:
Image

For example //~~~~~ or //------ working well
Image

Steps to reproduce:

  1. Go to any c++ code and write a function separator in //=== /n ... //==== format
  2. Click on method which are having new comment
  3. See incorrect markdown processing

Note:
C_Cpp: Markdown In Comments setting in case of "disable" helps to avoid scaling of the //=== template, but === still show in hover

Expected behavior:
No scaling of the hover and no ====== is visible in comment.

Configuration and Logs

{
    "configurations": [
        {
            "name": "Linux",
            "includePath": [
                "${workspaceFolder}/src/**"
            ],
            "defines": [],
            "cStandard": "c17",
            "cppStandard": "gnu++17",
            "intelliSenseMode": "linux-clang-x64",
            "mergeConfigurations": true,
            "browse": {
                "databaseFilename": "${workspaceFolder}/build/browse.vc.db",
                "limitSymbolsToIncludedHeaders": false
            },
            "compilerPath": "/usr/bin/clang++-20",
            "compileCommands": "${workspaceFolder}/build/compile_commands.json",
            "configurationProvider": "ms-vscode.cmake-tools"
        }
    ],
    "version": 4
}

Other Extensions

No response

Additional context

No response

@sean-mcmanus sean-mcmanus added bug Language Service Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. Works in VS So we'd need to fix it for VS Code to reach parity. labels Nov 13, 2024
@sean-mcmanus
Copy link
Collaborator

@dpasukhi It's a bug with our documentation comment implementation. It doesn't repro with VS 2022, which has a different implementation:

Image

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. Language Service Works in VS So we'd need to fix it for VS Code to reach parity.
Projects
Status: No status
Development

No branches or pull requests

2 participants