Reputation: 63134

IntelliJ show JavaDocs tooltip on mouse over

In Eclipse, when hovering over a method, variable, etc. a tooltip is displayed with the corresponding JavaDocs. Is there such a feature in IntelliJ?

Upvotes: 681

Answers (22)

Grobenek

Reputation: 51

If you are on MacOS, the fix was for me to disable: Settings -> Appearance & Behavior -> Appearance -> Support screen readers

Upvotes: 2

vikasing

Reputation: 11772

For IntelliJ 13, there is a checkbox in Editor's page in IDE Settings

enter image description here

EDIT: For IntelliJ 14, the option has been moved to Editor > General page. It's the last option in the "Other" group. (For Mac the option is under the menu "IntelliJ Idea" > "Preferences").

EDIT: For IntelliJ 16, it's the second-to-last option in Editor > General > Other.

EDIT: For IntelliJ Ultimate 2016.1, it's been moved to Editor > General > Code Completion.

EDIT: For IntelliJ Ultimate 2017.2, aka IntelliJ IDEA 2017.2.3, there are actually two options:

In Editor > General > Other (section) > Show quick documentation on mouse move - delay 500 ms

Select this check box to show quick documentation for the symbol at caret. The quick documentation pop-up window appears after the specified delay.

In Editor > General > Code Completion (sub-item) > Autopopup documention in 1000 ms, for explicitly invoked completion

Select this check box to have IntelliJ IDEA automatically show a pop-up window with the documentation for the class, method, or field currently highlighted in the lookup list. If this check box is not selected, use Ctrl+Q to show quick documentation for the element at caret.
Quick documentation window will automatically pop up with the specified delay in those cases only, when code completion has been invoked explicitly. For the automatic code completion list, documentation window will only show up on pressing Ctrl+Q.

EDIT: For IntelliJ Ultimate 2020.3, the first option is now located under Editor > Code Editing > Quick Documentation > Show quick documentation on mouse move

Upvotes: 945

s7vr

Reputation: 75984

In 2020.1 there is in editor javadocs rendering has been added. Screen shots borrowed from intellij documentation.

Upvotes: 1

Leviand

Reputation: 2805

From IntelliJ Ultimate 2018.1.5, aka IntelliJ IDEA 2018.1.5, till 2019.3 , there are actually two options under File -> Preferences:

In Editor > General > Other (section) > Show quick documentation on mouse move - delay 500 ms
- Select this check box to show quick documentation for the symbol at caret. The quick documentation pop-up window appears after the specified delay.
In Editor > General > Code Completion (sub-item) > Auto-display documentation in 1000 ms
- Select this check box to have IntelliJ IDEA automatically show a pop-up window with the documentation for the class, method, or field currently highlighted in the lookup list. If this check box is not selected, use Ctrl+Q to show quick documentation for the element at caret.
- Quick documentation window will automatically pop up with the specified delay in those cases only, when code completion has been invoked explicitly. For the automatic code completion list, documentation window will only show up on pressing Ctrl+Q.

Upvotes: 7

Slimane Deb

Reputation: 323

In Intellij 2019, I did: File > Settings > Editor > General option Show quick documentation on mouse move.

Upvotes: 3

Praveen Tiwari

Reputation: 1320

I tried many ways mentioned here, especially the preference - editor - general - code completion - show documentation popup in.. isn't working in version 2019.2.2

Finally, i am just using F1 while caret is on the type/method and it displays the documentation nicely. This is not ideal but helpful.

Upvotes: 1

pcxpert

Reputation: 1

The answer is CTRL + P (NOT CTRL + Q)

Someone else posted this answer on JetBrains forum: The idea is a different IDE. Try to discover its features and try to make the best of it, rather than trying to emulate whatever you used before. For the most part, Idea has very high usability (much better than Eclipse IMHO) and is streamlined for supporting code editing as best as possible (rather than relying on wizards too much for example).

Javadoc: Ctrl-Q
A quick view of the implementation: Ctrl-Shift-I
Show context: Alt-Q
Show parameters (in a method call): Ctrl-P
Show error description. Ctrl-F1

... plus many more shortcuts to navigate in code and different idea views.

I think it rather nice that you can see just the specific bit of information you are interested in with a simple keystroke. Have a look at the menus which will also show the possibly modified shortcuts for your keymap.

0 Avatar Jens Voß Created June 12, 2008, 09:26 And, elsandros, in addition to what Stephen writes: Since you seem to be interested in IDEA's keyboard shortcuts, I highly recommend the "Key Promoter" plugin which helps you memorize the relevant shortcuts quickly.

Also very useful is the "Goto Action" feature, invoked by Ctrl-Shift-A. In the popup, you can enter a keyword (e.g. "Javadoc"), and the IDE tells you the available actions matching your search, along with keyboard shortcuts and the containing action groups (which often also give you a clue about how to navigate to the action using the menu).

Upvotes: -1

avp

Reputation: 3350

All of the above methods are useful but one basic thing missing you need to have src.zip in your JDK (C:\Program Files\Java\jdk1.8.0_171). I assumed it comes preinstalled but for some reason, it was not present in my installation. Another thing to check is if your project is using the specified (1.8.0_171 in this case) JDK.

Upvotes: 0

Enrico Giurin

Reputation: 2273

The easiest way, at least for me, was:

Ctrl+Shift+A
Type: show document
Show quick documentation on mouse move (set it to ON)

Upvotes: 8

ozzylee

Reputation: 301

A note for Android Studio (2.3.3 at least) users, because this page came up for my google search "android studio hover javadoc", and android studio is based on Intellij:

See File->Settings->Editor->General: "show quick documentation on mouse moves", rather than File->Settings->Editor->General->Code Completion "Autopopup documentation in (ms) for explicitly invoked completion" and "Autopopup in (ms)", which has been previously talked about.

Upvotes: 1

fedorqui

Reputation: 290275

For Intellij 15, use the checkbox in File > Settings > Editor > General option Show quick documentation on mouse move.

You can also get there by typing "quick" or something similar in the search box:

Upvotes: 25

Gemtastic

Reputation: 6433

On mac in IntelliJ Ultimate (trial) 14 I have mine under Settings > Editor > General > Code completion. The tooltip short is F1 on my laptop.

It's called "Autopopup documentation in (ms):"

enter image description here

Upvotes: 1

Vy Do

Reputation: 52656

IntelliJ IDEA 14.0.3 Ultimate:

Press Ctrl+Alt+S, then choose Editor\General choose Show quick domentation on mouse move

enter image description here

Tips: Look at the top right conner (gear icon) at JavaDoc pop-up window, You can choose:
- Show Toolbar
- Pinded Mode
- Docked Mode
- Floatting Mode
- Split Mode

enter image description here

Upvotes: 14

Amap

Reputation: 151

File-->Settings-->Editor

Check "Show quick doc on mouse"

Now when you put the mouse over a method a tooltip with the documentation will appear. Sometimes the tooltip size is too small and you will have to resize it moving the mouse down to the bottom of the tooltip.

Upvotes: 2

Jonas Pedersen

Reputation: 1054

In IntelliJ IDEA 14, it has moved to: File -> Settings -> Editor -> General -> "Show quick doc on mouse move"

Upvotes: 3

Matthew Chen

Reputation: 1594

In Intellij13, you can use Editor configuration like below: enter image description here

Upvotes: 24

liberty

Reputation: 413

After doing CTRL+Q, you can

Pin the tooltip (top right corner)
Check Docked Mode (under gear in top right after pinning)
Size as desired
Click icon for Auto show documentation for selected item

Then when you move your cursor, the documentation will appear in this box. It costs you a little screen real estate, but I find it's worth it.

I'd post a screenshot but SO won't let me post images.

Upvotes: 28

Michal

Reputation: 3276

On my IntelliJ U on Mac I need to point with cursor on some method, variable etc. and press [cntrl] or [cmd] key. Then click on the link inside popup window which appeared to see JavaDocs

Upvotes: 0

Cjkjvfnby

Reputation: 134

IDEA has "find action":

Open "Help" menu, type "doc", move cursor to "Quick Documentation" it will be highlighted.

Also "find action" can be called from hot key (you can find it in settings->hotkeys)

Upvotes: 1

Bart Kiers

Reputation: 170278

Up until IntelliJ version 11, no, not just by hovering over it. If the cursor is inside the method- or attribute name, then CTRL+Q will show the JavaDoc on *nix and Windows. On MacOSX, this is CTRL+J.

Quote: "No, the only way to see the full javadoc is to use Quick Doc (Ctrl-Q)." -- http://devnet.jetbrains.net/thread/121174