How to reference javadocs to dependencies in Maven's eclipse plugin when javadoc not attached to dependency

Question

I use Eclipse, Maven, and Java in my development. I use Maven to download dependencies (jar files and javadoc when available) and Maven's eclipse plug-in to generate the .project and .classpath files for Eclipse. When the dependency downloaded does not have attached javadoc I manually add a link for the javadoc in the .classpath file so that I can see the javadoc for the dependency in Eclipse. Then when I run Maven's eclipse plugin to regenerate the .classpath file it of course wipes out that change.

Is there a way to configure Maven's eclipse plug-in to automatically add classpath attributes for javadoc when running Maven's eclipse plug-in?

I'm only interested in answers where the javadoc and/or sources are not provided for the dependency in the maven repository, which is the case most often for me. Using downloadSources and/or downloadJavadocs properties won't help this problem.

ddimitrov · Answer 1 · 2008-10-18T08:31:17.247

42

From the Maven Eclipse Plugin FAQ

The following example shows how to do this in the command-line:

mvn eclipse:eclipse -DdownloadSources=true  -DdownloadJavadocs=true

or in your pom.xml:

<project>
  [...]
  <build>
    [...]
    <plugins>
      [...]
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-eclipse-plugin</artifactId>
        <configuration>
          <downloadSources>true</downloadSources>
          <downloadJavadocs>true</downloadJavadocs>
        </configuration>
      </plugin>
      [...]
    </plugins>
    [...]
  </build>
  [...]
</project>

edited Oct 18 '08 at 08:31

answered Sep 18 '08 at 21:26

ddimitrov

3,293
3
31
46

9

According to question, sources and javadoc aren't in central, so downloadSources, downloadJavadocs won't help. – Geoffrey Wiseman Nov 10 '10 at 01:21

score 31 · Answer 2 · answered Feb 07 '12 at 12:24

31

I'm running STS 2.8.1 which is basically eclipse + spring tools; In an existing maven project, I right clicked on the project -> maven -> Download Sources and Download JavaDocs

answered Feb 07 '12 at 12:24

luckyphil

411
4
3

Works in IntelliJ 2017 too. – Basil Bourque Mar 13 '17 at 01:48

score 25 · Answer 3 · edited May 23 '17 at 11:33

25

As mentioned in How to download sources and javadoc artifacts with Maven Eclipse plugin from other repository?, you can do this:

In Eclipse go to Windows-> Preferences-> Maven. Check the box that says "Download Artifact Javadoc." That has worked well for me.

Maven Preferences

edited May 23 '17 at 11:33

Community

1
1

answered Jun 19 '14 at 19:37

Philippe

4,088
4
44
49

1

This does not answer the question. The problem is the javadoc is not in the maven repo so checking that makes no difference. – John in MD Jun 23 '14 at 14:13

score 17 · Accepted Answer · answered Sep 27 '08 at 04:15

17

You might consider just avoiding this problem completely by installing the javadoc jar into your local repository manually using the install-file goal and passing in the -Dclassifier=javadoc option. Once you do that the .classpath that mvn generates should be correct.

If you use a remote repo as a proxy to central you could also deploy the javadocs to that repo and then everyone else who uses that proxy will now get the javadocs automatically as well.

answered Sep 27 '08 at 04:15

Mike Deck

18,045
16
68
92

8

Would just be nice if you could specify the URL to the official Javadocs in the dependency tag. – Thorbjørn Ravn Andersen Dec 21 '11 at 09:52
I don't think this is a solution, I think it's better to configure the pom.xml file as ddimitrov and Philippe wrote – Alex8752 Aug 16 '19 at 22:28

score 4 · Answer 5 · edited Jun 20 '20 at 09:12

Generally Javadocs are not primarily used as dependency . Because these are neither required at compile nor runtime. It’s just to help the developer while developing or debugging.

Assuming using the java IDE Eclipse we can use the java docs as referenced. Following are the approaches we can associate the javadocs/sources with the respective jars.

1. If it’s non-maven project :

Download the javadocs jar or zipped file, whatever available and placed it in some directory. Right click on the application project in the IDE Eclipse, click Properties and choose Java Build Path then select tab Libraries under the Java Build Path. Now expand the jar you want to link with java docs/source. Select the Javadoc location link and click on Edit button, a new window appears where we need to choose the javadocs jar path. Click OK and we have linked the javadoc/source with the respective jars.

2. If it’s a maven project

If we are using the Maven project then go to jar files under the Maven dependency under the project in Project Explorer view as shown below. Now right click on the jar file you want to add the Javadoc/source,  choose Maven then click on Javadoc or Source you want to link with the project. Now IDE will automatically download the required javadoc/source and will link it with the respective jar in the project.

You can verify this by right click on the project in the IDE and click on Java Build Path and select the Libraries tab under the Java Build Path and then expand the desired jar, here when you click the Edit button you will see the linked path of the Javadoc/Source with the respective jar as shown below in the image.

3. If it’s Maven project and we are setting the default behavior:

Eclipse will aquatically download the javadoc/source along with the main required jar at the starting. By default setting instruction to Maven to download the Javadoc/sources for all the jars linked in the project.

Click Windows – preferences – select Maven and click the checkbox Download Artifact Javadoc as shown below

Now click on apply and save it and now when you create new Maven project , by default the Javadocs will get downloaded and linked with all the dependent jars in the project.
You can verify by right click on the project and Properties and under Java Build path can see the javadocs are linked with all the jars as shown below.

If your project is Maven project then It’s always best to use 2nd approach because by using this approach the IDE and Maven, takes care of downloading the correct version of the Javadoc/source and linked it with the relative jar as well.

Approach 3rd is bit costly because the javadoc/sources will be downloaded for-all the dependent jars, may be you are not interested for javadocs/sources for all the dependent jars.

score -2 · Answer 6 · answered Sep 04 '08 at 18:30

-2

Would having the sources for the dependency help? You can tell the eclipse plugin to download those (and refer to them in the .classpath) with -DdownloadSources=true

answered Sep 04 '08 at 18:30

matt b

138,234
66
282
345

Request explicitly says javadoc not in central repo, and doesn't want to use -DdownloadSources as a result. – Geoffrey Wiseman Nov 10 '10 at 01:20
Looks like OP edited his question (perhaps in response) after this answer was posted. Doesn't explain why the other answer has so many votes, when it's giving the exact answer that OP wanted to avoid. – Vivek Chavda Jun 06 '17 at 16:29

How to reference javadocs to dependencies in Maven's eclipse plugin when javadoc not attached to dependency

6 Answers6

Linked