CODEWITHSUNDEEP
javamavenintellij-ideajavadoc
Dims
Dims

Reputation: 51059

Slow (non-quick) documentation in IntelliJ?

Can I just browse available javadocs with IntelliJ?

For example, I configured some library in Maven and it has javadoc available only on Maven repository.

It is lazy to download it by hand, unpack and open it with browser.

Is it possible to do this automatically and browse for some class by name? Without coding it first.

Upvotes: 1

Views: 423

Answers (1)

Javaru
Javaru

Reputation: 31936

The "how to download the documentation" question was answered in your other question. There's really not a way to directly browse the attached Javadocs, but there is a pseudo way to do it.

First I'll mention that in code, you can use the Quick Documentation shortcut (Ctrl+Q or ⌃,J on a Mac) to browse open the documentation for the class/method where your cursor is position. Once the quick documentation window is open, you can click the blue up arrow enter image description here, type Shift+F1 (not sure about the mac) to open the documentation in a browser. If the documentation is in a JAR file, and you have not done so previously, IDEA will offer to extract the Javadocs from the JAR file.

If you want to browse the JavaDoc for a class or method you have not yet used, there is a way to do it. Use the Go To Class action Ctrl+N (⌘,O) or the Go to Symbol (e.g., field, method, etc) Ctrl+Alt+Shift+N (⌘,⌥O) to "search" for the Class of method. (You will like want to hit the shortcut a second time so the "Include non-project classes/symbols" option gets selected.) Once you find it and it is selected in the list, instead of hitting Enter to go to the class or symbol like you normally would, use the Quick Documentation shortcut to view the Javadoc (and then optionally open it externally).

Upvotes: 3

Related Questions