-
-
Notifications
You must be signed in to change notification settings - Fork 78
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
Various bugfixes to display mouse-hover mdpopups for macros & functions properly #768
base: master
Are you sure you want to change the base?
Conversation
…not display variadic argument ellipsis '...'
… function declaration with syntax color in 'Body' section
…over a macro definition #define statement
…nts for macros, despite clang not doing this for us
@@ -45,7 +45,7 @@ | |||
{content} | |||
""" | |||
|
|||
FULL_DOC_TEMPLATE = """### Full doxygen comment: | |||
FULL_DOC_TEMPLATE = """### Detailed documentation: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This right here is an aesthetic change, which you are free to keep or throw out - I think it is more consistent since it is more similar to the title of the other related section, "Brief documentation".
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. |
…ent' -> 'Detailed documentation'
…nctions in mdpopups
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 83f6b68 |
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
…pup hoverdoc: one the reorder the sections in the popup, and another setting to display the documentation body text as markdown, rather than plaintext
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:
cursor.raw_comment
is alwaysNone
for a macro. I fixed this in commit 1e430d4, by adding some custom doc-comment-parsing logic to yourMacro_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:
...
ellipsis, notva_list
). I fixed this in commit d6d65b5Let me know if you have any questions/remarks.