Home » Java » IntelliJ tooltip shows JavaDocs

IntelliJ tooltip shows JavaDocs

Posted by: admin November 2, 2017 Leave a comment

Questions:

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

Answers:

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.
enter image description here

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

  1. 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.
  2. 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.
Questions:
Answers:

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

EDIT

Since IntelliJ 12.1, this is possible. See @ADNow’s answer.

Questions:
Answers:

It is possible in 12.1.

Find idea.properties in the BIN folder inside of wherever your IDE is installed, e.g. C:\Program Files (x86)\JetBrains\IntelliJ\bin

Add a new line to the end of that file:

auto.show.quick.doc=true

Start IDEA and just hover your mouse over something:

enter image description here

Questions:
Answers:

After doing CTRL+Q, you can

  1. Pin the tooltip (top right corner)
  2. Check Docked Mode (under gear in top right after pinning)
  3. Size as desired
  4. 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.

Questions:
Answers:

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

Questions:
Answers:

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

enter image description here

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

enter image description here

Questions:
Answers:

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

Questions:
Answers:

Adding on to what ADNow said. On the Macintosh:

  1. Right click on IntelliJ IDEA 12
  2. Click on the Show Package Contents menu option
  3. Open the bin folder
  4. Open idea.properties
  5. Add the line:

    auto.show.quick.doc=true

Questions:
Answers:

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

Questions:
Answers:

The easiest way, at least for me, was:

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

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)

Questions:
Answers:

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.

Questions:
Answers:

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

Questions:
Answers:

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

Questions:
Answers:

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.