search

microsoft / vscode-cpptools

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

Make \ref in doxygen comments a clickable link to the symbol #11131

Open spoorcc opened 1 year ago

spoorcc commented 1 year ago

Feature Request

In Doxygen you can make a reference to a symbol using the \ref command. It would be great if the referenced symbol could become a clickable link so you can jump to the implementation.

michelleangela commented 1 year ago

This would require VS Code to provide an API that allows link to comments, unless there is already one available.

spoorcc commented 1 year ago

Something like this? https://vscode-api.js.org/interfaces/vscode.DocumentLinkProvider.html#provideDocumentLinks

michelleangela commented 1 year ago

Yes, the DocumentLinkProvider is probably what would be needed.

KKghub commented 8 months ago

I see that if we write link to the file with prefix file:/// in comment, VSCode shows it as clickable link. and it supports relative links as well. For example:

image

It would be nice if we do not need to prefix it with file:/// to make it clickable, maybe similar to how markdowns detect it? 

[Test](./test.cpp)
mrx23dot commented 3 months ago

Why not generate doxygen html and clickaway in that?