Various bugfixes to display mouse-hover mdpopups for macros & functions properly

[LexouDuck]

Hello again ! And again, thank you for making this plugin, it has been of great use to me.

There were a couple of bugs with the mdpopup hover-doc feature (4 to be exact), so I have prepared 4 commits, which fix each of these. Here is an explanation for each one:

So, there were a couple of problems with how macros worked in the mouse-hover mdpopup display:

• The popup would only appear if the user hovered the mouse over the usage of a macro, and not when hovering the definition of the macro. I fixed this in commit 830452869bca55dcc0bdab54c00c96c1eb4cd80a
• The mdpopups for macros never showed any documentation comments: this is because clang doesn't keep this info, so cursor.raw_comment is always None for a macro. I fixed this in commit 1e430d4563028699d825d3df338bbaca913cc28c, by adding some custom doc-comment-parsing logic to your Macro_Parser utility class, in ./plugin/utils/macro_parser.py.

Also, there were some less important issues with how functions showed up in the mdpopup as well:

• Functions with variadic arguments did not display their last argument (I mean the ... ellipsis, not va_list). I fixed this in commit d6d65b5648d0e6b5b95967feeebe8da725c9da5a
• There was never a "Body" section for functions in mdpopups, only the "Declaration" section. I fixed this in commit da2592c122fb0d3fe39b5643c6b4ad2c04dc9b2b. Note that even though the "Declaration" and "Body" sections both show the function prototype declaration, it is still useful to have "Body" since it has syntax coloring, which the "Declaration" section does not have (since it has hyperlinks).

Let me know if you have any questions/remarks.

[LexouDuck]

Ah, it seems that the tests have failed for style/lint reasons, because some of my lines of code go beyond the 80th char column. Will fix this right away.

[LexouDuck]

There were also a handful of tests that needed updating, since mdpopups for functions now have a "Body" section as well. I have fixed this in commit 83f6b68ef647399cc523f33ea5d29c4b27348a1a

[codecov[bot]]

Codecov Report

Merging #768 (268c5c4) into master (3b16eb1) will decrease coverage by 1.36%. The diff coverage is 50.28%.

@@            Coverage Diff             @@
##           master     #768      +/-   ##
==========================================
- Coverage   82.16%   80.79%   -1.37%     
==========================================
  Files          39       39              
  Lines        3319     3458     +139     
==========================================
+ Hits         2727     2794      +67     
- Misses        592      664      +72     

Impacted Files	Coverage Δ
plugin/completion/lib_complete.py	80.71% <0.00%> (-1.11%)	:arrow_down:
plugin/settings/settings_storage.py	80.69% <ø> (ø)
plugin/utils/macro_parser.py	45.83% <21.95%> (-29.17%)	:arrow_down:
plugin/error_vis/popups.py	80.49% <60.46%> (-9.45%)	:arrow_down:
plugin/utils/thread_pool.py	96.77% <0.00%> (+3.12%)	:arrow_up:
plugin/utils/progress_status.py	73.77% <0.00%> (+13.11%)	:arrow_up:

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update c2e8913...268c5c4. Read the comment docs.