How to See Javadoc in Intellij Idea

How to see JavaDoc in IntelliJ IDEA?

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:

missing javadoc detail in intelliJ

This is because you didn't set Java source path in the project structure dialog.

Go to File > Project Structure and select SDKs from the left side. Then select your project JDK level (In your case it should be 1.8) and add JDK source path in Sourcepath tab.

Usually it should be named as src.zip and placed inside your JDK folder.

IntelliJ show JavaDocs tooltip on mouse over

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

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:

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.

1. 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

How to make IntelliJ display the Javadoc of autocompletion suggestions?

Once you put a dot and the suggestions appear, press F1 (which is the default shortcut for "Quick Documentation" in most keymaps). The documentation for the currently selected method then appears as a card as show in the image. Then you can either use the up/down arrow keys or start typing the method name to select it. The documentation card will reflect accordingly.

You can also click on the pin icon on top right of the documentation card to expand it if required.

Intellij IDEA show javadoc automatically

Settings | Editor | General |Code Completion | Autopopup documentation in (ms).

UPDATE: latest versions have an option to show JavaDoc on mouse move.

Where is the Javadoc plugin settings in Intellij Idea?

IntelliJ has built-in support for generating JavaDocs so unless there's something missing from that feature you won't need a plugin.

You can access this feature from Tools > Generate JavaDoc ...

More details in the docs here and here.

Edit 1: Based on your last comment I think you want to create the JavaDocs rather than generate the JavaDoc output. If so, then IntelliJ will create a Javadoc for you when you:

• Place the caret in an empty line immediately above a method
• Type /**
• Hit the ENTER key

Given this method:

public void run(long distance) throws ExtremeFatigueException {

}

The /** + ENTER keystroke combination will generate this skeleton JavaDoc:

/**
 *
 * @param distance
 * @throws ExtremeFatigueException
 */

The format of the JavaDocs in IntelliJ is controlled in Preferences > Editor > Code Style > Java then click on the JavaDoc tab.

Show Documentation panel in IntelliJ

View > Quick Documentation > ⋮ > Open as Tool Window

See this answer how to view quick documentation in IntelliJ IDEA. You are choosing View > Quick Definition, but should choose Quick Documentation instead (“definition” versus “documentation”).

Once you have the popup open, there is an option to make it a tool window (Open as Tool Window) in the vertical ellipsis (⋮) pop-up menu.

Or you may see the vertical ellipsis (⋮) pop-up menu in the bottom-right corner.

Another way to switch the display mode is to press the shortcut you are using to display the quick documentation twice.

Either way, you should see the Documentation panel in the lower right corner of the IDE window.

In IntelliJ, how can I view the generated docs in the browser, using Shift + F1

Generated JavaDoc folder needs to be added in the Project Structure dialog for the module in the Paths tab:

Attaching additional javadoc in Intellij IDEA

You can attach javadoc to any library you have configure in your module or project. Just access the project structure windows (File -> Project Structure), then select "modules" and select the module that has the dependency you want to configure.

Then select the "Dependencies" tab, select the dependency that's missing the javadoc and click "Edit". In the window that just showed up you see two buttons "Add" and "Specify Javadoc URL". If you have the javadoc in a jar file select the first one, if you want to point to a web site that contains the javadoc select the latest.
That's it.

---

Related Topics