Tooltip for documentation window (CTRL-Q)

I love PhpStorm! In fact, there's really only one thing that's been bothering me: that there's no automatic tooltip that gives you the documentation for certain function or member - the same information you get when you press CTRL-Q. Or am I overlooking it ?

Up till version 3.0.1 there was a work-around that I found sufficient: you could press CTRL-Q and dock this documentation window to for instance the right-hand side of the screen. When you 'selected' another function, the documentation window updated to reflect this. However, since v4.0.1 the documentation window no longer updates when you switch to another function - you have to press CTRL-Q again.

The ideal solution would be to add an option (I think it would fit nicely in the 'Editor' > 'Code Completion' settings page), where you can enable/disable this 'automatic tooltip' and specify the delay in ms, just like for the other 'code completion' settings.
Also, is it possible to again make the (docked) documentation window update to the current (function) selection ?

PS: I'm using the Windows version, maybe the other OS versions do have such a tooltip.

3 comments
Comment actions Permalink

Hi Vincent,

there's no automatic tooltip that gives you the documentation for certain function or member - the same information you get when you press CTRL-Q. Or am I overlooking it ?

No. There is no such thing. I personally disabling such functionality in every product that has it -- it distracts more than helps (unless, of course, if I could place it somehwere on a side, where it will not cover my code or another important tool window/panel; But even then -- why do I need to see help about every single function/variable/element?).

Also, is it possible to again make the (docked) documentation window update to the current (function) selection ?


Sure.

1. Make Quick Documentation window "sticky" (always visible) --> press Ctrl+Q twice.
2. There, activate 4th button (Auto show documentation for selected element)

0
Comment actions Permalink

Excellent, I overlooked that "Show documentation for current element automatically" button, silly of me. Thanks for pointing that out!

I understand that some developers find this functionality distracting and that this is the reason why it's not even supported in PhpStorm. I would be surprised however if there isn't a reasonably large group of developers who do like that functionality. I guess I'm used to it being a Visual Studio developer...

I wonder if it's not at least worth adding the option in the settings menu, leaving it off by default if you feel that's what most users prefer.

But anyway, now that the content of the window is updated with the current selection again, that's sufficient for me!

0
Comment actions Permalink

http://youtrack.jetbrains.com/issue/IDEABKL-5999

I wonder if it's not at least worth adding the option in the settings menu, leaving it off by default if you feel that's what most users prefer.


Considering in which section/project this ticket is currently located -- the answer will be "not really, but maybe one day in the future"

0

Please sign in to leave a comment.