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

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

Open
Aric5301 opened this issue May 10, 2024 · 1 comment
Labels
enhancement Improvement to an existing feature Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. Feature Request

Comments

@Aric5301
Copy link

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!

@browntarik browntarik added Feature Request Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. enhancement Improvement to an existing feature labels May 13, 2024
@browntarik
Copy link
Contributor

Thank you for requesting this feature, please follow this thread for future updates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement to an existing feature Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. Feature Request
Projects
None yet
Development

No branches or pull requests

2 participants