How to see JavaDoc in IntelliJ IDEA

Question

I just switched from Eclipse to IntelliJ    IntelliJ lacks one feature from Eclipse - when you put your mouse over a method  Eclipse shows javadoc info  I think the way to show it is to use a shortcut - command J  but when I click it  I get something wrong as on the screen shot below  Please advise me on how I can quickly get javadoc information  I need to at least know what type a method returns

User · Answer

For me  it wasn t just getting the javadoc window to open  but also getting the complete javadoc to present   You may still get a sparse javadoc that is based solely on the method signature if you are importing libraries from a Maven repository and do not tell Idea to include the javadocs in the download   Be sure to tick the  JavaDocs  option in the  Download Library From Maven Repository  dialog  which can be found under Project Structure -  Projtect Settings -  Libraries

User · Answer

Go to File Settings  Editor  click on General    Scroll down  then   Show quick documentation on mouse move

User · Answer

IntelliJ IDEA 15 added this feature  Now it is available as EAP   As you can see in the picture below  the caret position doesn t influence the cursor position    This feature was implemented in IntelliJ IDEA 15 142 4675 3 Release Notes

User · Answer

I have noticed that selecting the method name and pressing F2 Quick Documentation  dispalys it s JavaDoc   I am using Intellij 2016  and Eclipse Keymap

User · Answer

Configuration for IntelliJ IDEA CE 2016 3 4 to enable JavaDocs on mouse hover  I am running IntelliJ IDEA on Mac OS but believe that Linux Windows should have similar options  Autopopup docs  IntelliJ IDEA  gt  Preferences  gt  Editor  gt  General  gt  Code Completion  Documentation on mouse move  IntelliJ IDEA  gt  Preferences  gt  Editor  gt  General  NOTE  Please hit Apply button to apply these settings

User · Answer

Alternatively you can position your cursor on the item and show JavaDoc using      CTRL Q   which is the default shortcut   Edit  As Methical mentioned on Mac the shortcut is     CTRL j    j not   j

User · Answer

Go to Settings -  Editor -  General then enable Show quick documentation on mouse move

User · Answer

Use View   Quick Documentation or the corresponding keyboard shortcut  by default  Ctrl Q on Windows Linux and Ctrl J on macOS or F1 in the recent IDE versions   See the documentation for more information   It s also possible to enable automatic JavaDoc popup on explicit  invoked by a shortcut  code completion in Settings   Editor   General   Code completion  Autopopup documentation      Yet another way to see the quick doc is on mouse move

User · Answer

The closest to Eclipse will be Ctrl Button2 Click  Scroll click   It s called Quick Doc in IntelliJ  I wish guys from JetBrains one day add quick doc like Eclipse with Ctrl Mouse Move it s so much better   In my case only with only mouse move is a bit annoying  so if you search in Preferences Settings --  Keymap for  quick documentation  you will find    Win-Linux   Ctrl Q  and  Ctrl Button2 Click   Scroll click   Mac   Ctrl J  and  Ctrl Button2 Click   Scroll click

User · Answer

There is nice feature which shows quick documentation when your mouse is over element   IntelliJ 14  Editor   General -  Show quick documentation on mouse move  Older versions  Add the following line to idea properties file   auto show quick doc true

User · Answer

To best mirror Eclipses functionality  enable the following settings    IDE Settings Editor -  Other Show quick doc on mouse move IDE Settings Editor Code Completion -  Autopopup Documentation   To see the javadoc in the autocomplete menu  hit     to get the popup  then hover over the object you are working with  once you get the javadoc popup  you can select an item in the popup to switch the javadoc over  Not ideal    But its something   As another note  The search functionality of the options menu is very useful  Just type in  doc  and you will see all the options for doc   Also  searching for  autopopup doc  will not only find each of the options  but it will also highlight them in the menu  Pretty awesome     Edit  Going beyond the initial question  this might be useful for people who just want quick and easy access to the docs   After using this for a few more days  it seems just getting used to using the hotkey is the most efficient way  It will pop up the documentation for anything at the spot of where your text input marker is so you never have to touch the mouse  This works in the intellisense popup as well and will stay up while navigating up and down   Personally  Ctrl Q on windows was not ideal so I remapped it to Alt D  Remaping can be done under IDE Settings Keymap  Once in the keymap menu  just search for Quick Documentation

[java] How to see JavaDoc in IntelliJ IDEA?

Examples related to java

Examples related to intellij-idea

Examples related to ide

Examples related to javadoc