vscode-cpptools icon indicating copy to clipboard operation
vscode-cpptools copied to clipboard

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

Open spoorcc opened this issue 1 year ago • 4 comments

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.

spoorcc avatar Jun 26 '23 08:06 spoorcc

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

michelleangela avatar Jun 26 '23 18:06 michelleangela

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

spoorcc avatar Jun 26 '23 19:06 spoorcc

Yes, the DocumentLinkProvider is probably what would be needed.

michelleangela avatar Jun 26 '23 20:06 michelleangela

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)

KKghub avatar Feb 15 '24 06:02 KKghub

Why not generate doxygen html and clickaway in that?

mrx23dot avatar Jul 12 '24 13:07 mrx23dot