1049111 - Show parameter names on hover

Status: RESOLVED WONTFIX

(Webtools Graveyard :: DXR, defect)

Description

[Jeff Muizelaar [:jrmuizel]]

It would be handy to be able to see the parameter names when hovering over a function call.

e.g. 

void foo(int numApples, int numOranges);

foo(4, 5);

hovering over '4' would display 'numApples'

Comment 1

[Erik Rose [:erik][:erikrose]]

Not a bad idea.

Comment 2

[Srinidhi Kaushik]

Hey, can I work on this? I'm new here and interested in contributing to DXR. I just need a little help getting started.

Comment 3

[Erik Rose [:erik][:erikrose]]

Sure! Most of the action is happening on the "es" branch right now, so you should do your work there (especially since the code you'll need to touch has been totally rewritten there). The branch should land in a few weeks. Here's the developer setup documentation: http://dxr.readthedocs.org/en/es/development.html.

Once you get everything set up, you'll be able to move on to actually implementing this feature. For that, focus on the "title" tuple element returned from the refs() method of FileToIndex in the clang plugin: http://dxr.readthedocs.org/en/es/development.html#dxr.plugins.FileToSkim.refs. For an example, see this code in the clang plugin:

            self._common_ref(create_menu=macro_menu,
                             view=itemgetter('macro'),
                             get_val=itemgetter('text')),

That bubbles up the values of macros into title attrs.

Pop into #static if you have any questions, or even just to say hi!

Comment 4

[Srinidhi Kaushik]

(In reply to Erik Rose [:erik][:erikrose] from comment #3)
> Sure! Most of the action is happening on the "es" branch right now, so you
> should do your work there (especially since the code you'll need to touch
> has been totally rewritten there). The branch should land in a few weeks.
> Here's the developer setup documentation:
> http://dxr.readthedocs.org/en/es/development.html.
> 
> Once you get everything set up, you'll be able to move on to actually
> implementing this feature. For that, focus on the "title" tuple element
> returned from the refs() method of FileToIndex in the clang plugin:
> http://dxr.readthedocs.org/en/es/development.html#dxr.plugins.FileToSkim.
> refs. For an example, see this code in the clang plugin:
> 
>             self._common_ref(create_menu=macro_menu,
>                              view=itemgetter('macro'),
>                              get_val=itemgetter('text')),
> 
> That bubbles up the values of macros into title attrs.
> 
> Pop into #static if you have any questions, or even just to say hi!

Alright, thanks a lot! I will start setting things up and go through the documentation; will get back to you if I make any progress or if I have any further queries.

Comment 5

[Sylvestre Ledru [:Sylvestre]]

DXR is no longer available. Searchfox is now replacing it.
See meta bug 1669906 & https://groups.google.com/g/mozilla.dev.platform/c/jDRjrq3l-CY for more details.