extensions icon indicating copy to clipboard operation
extensions copied to clipboard

Doxygen support in tooltips

Open jansol opened this issue 2 years ago • 0 comments

Check for existing issues

  • [X] Completed

Describe the feature

Follow-up from zed-industries/zed#5992 as per comments there.

TL;DR: Doc comments a la Doxygen or Javadoc can provide very helpful descriptions e.g. for individual function parameters. These descriptions don't currently get parsed and instead the doc comment is replicated verbatim in the hover tooltip. It would be better if the doc comment's \param or @param component would be extracted and shown as help for the respective parameter in the function hover tooltip. Ideally an individual parameter's help could even be shown when hovering over that parameter in a function call, in addition to the hover tooltip for the value/variable that is written there.

This appears to be in part a limitation of language servers:

No idea what the status of other languages is.

If applicable, add mockups / screenshots to help present your vision of the feature

No response

jansol avatar Sep 25 '23 12:09 jansol