microsoft / vscode-cpptools

Official repository for the Microsoft C/C++ extension for VS Code.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Make hover menu show documentation from source file instead of header file if it's written in the Doxygen format

Aric5301 opened this issue · comments

Feature Request

Hi.
My current convention for programming is that I write Doxygen styles documentation for functions source files, and only write a small description for functions in header files.
The current behavior of the feature in this extension that shows function documentation for functions that are defined on another compilation unit when I hover over their call seems to be the following:

  1. If a function declaration in a header file has any documentation, display it.
  2. Otherwise, if the source file has any documentation for that function, display it.

This means, that what I get shown is the small function description instead of the full documentation available in the source file.

My suggested feature it to either add an extension setting that let's me choose whether it first looks for the documentation in the header or source file, or add a setting that prioritizes taking the Doxygen style documentation (so in my case it will take documentation from the source file since the header style comment isn't written in Doxygen style.

So, in the case of:
image
image

Current behavior

image

Suggested behavior

image

Thank you very much!