Attaching additional javadoc in Intellij IDEA

Question

When I use quick documentaion lookup (Ctrl+Q) on j2ee classes or annotations in IDEA I only get an empty javadoc. It only contains the basics like class name.

How do I add the javadoc to the libs IDEA provides itself?

score 97 · Accepted Answer · edited Apr 27 '17 at 10:51

97

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.

edited Apr 27 '17 at 10:51

Alexandre Daubricourt

3,323
1
34
33

answered Sep 18 '08 at 10:37

Hugo Palma

3,376
3
21
22

5

I use a directory where I keep all my libraries. I show put my jars there and they are automatically added to the classpath. How can I do the same with the javadoc archives? – simao Feb 04 '11 at 00:26
4

If you have maven or gradle dependency handling, you can also switch on an autofetch on documentation, This will autmatically add the right JavaDoc for the dependency. You can find the option under: File > Settings > Build, Execution, Deployment > Build Tools > Maven > Importing : Automatically Download : Documentation – Xtroce Apr 14 '16 at 11:09
2

I use Android Studio which is based on Intellij Idea but it doesn't have any of the options described here. – vovahost Jul 21 '17 at 14:42
If you have a zip, jar, or directory with the documentation downloaded, just add it the same way you add other zips, jars, and directories (normal plus) and it will be used as a JavaDoc. – Solomon Ucko Dec 28 '17 at 16:07
Can somebody please kindly specify in which format I should specify the path to a local directory with docs? – vintprox Jul 31 '20 at 07:06

score 21 · Answer 2 · answered Mar 26 '19 at 00:22

21

If using maven:

"right click on your pom.xml" -> "Maven" -> then choose "Download Sources and Documentation"

To avoid this in the future: "Preferences" -> "Build, Execution, Deployment" -> "Build Tools" -> "Maven" -> "Importing" -> Check the Automatically download Sources and Documentation boxes.

Credit to Yacov Schondorf and Stephen Boesch from Intellij user forums.

answered Mar 26 '19 at 00:22

JMess

623
9
11

1

Is there a way to achieve the same with Gradle build tool? – iamtodor May 31 '20 at 17:40

albfan · Answer 3 · 2010-03-07T12:27:57.577

What about documentation for an extension API? I had added the j3d API to my jdk1.6 and use it succesfully, next step, get the javadoc

Forget the links on java.sun.com (It is a mess) Go directly to java.net and get all the stuff (API, javadoc, get the source even -for every package-)

Go to your jdk and selected the documentation path and add the javadoc zip. Go to the source tab and add the source's zip

You're done.

Actually only the source is needed to enjoy javadoc and the uncompiled classes

score 0 · Answer 4 · answered Dec 12 '19 at 02:38

0

right click on the maven pom.xml -> "Maven" ->Download documentation,wait for a sec,you'll make it!

answered Dec 12 '19 at 02:38

oneslide icywater

21
2
10

Attaching additional javadoc in Intellij IDEA

4 Answers4

Linked