JDK 11+ and Javadoc

Question

Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules.

Has anyone been able to make javadoc work without having to change the source version to 1.8 (as suggested in other forums)? I'm using JDK v11.0.5 and the issue still present (also with JDK 12+).

Edit: This error originated from maven and thrown by the maven-javadoc-plugin. I have not been able to make it work for JDK 11+ even with the <source>8</source> configuration.

I think this question needs some more details. Do you use maven? Do you use or have you tried to use modules in your project? — rü-, Nov 18 '19 at 11:38
@rü- you're right, I have updated the post, thanks. Yes, I am using maven with a multi-module setup. — Rafael Ibasco, Nov 18 '19 at 12:18

score 35 · Answer 1 · answered Feb 20 '20 at 14:42

35

As suggested in OpenJDK issue tracker this can be worked around with defining source on Javadoc plugin:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
        <source>8</source>
    </configuration>
</plugin>

answered Feb 20 '20 at 14:42

Roman Grigoriadi

1,552
11
8

7

Probably, you didn't read the question completely. OP has clearly mentioned: `Has anyone been able to make javadoc work without having to change the source version to 1.8` – Arvind Kumar Avinash Feb 20 '20 at 14:48
3

it works for me. I use: ${java.version} and in properties it's java 11. I just had to specify the version for some reason. – ranma2913 Mar 09 '20 at 22:40
How can you do this in Gradle? – Raffi Khatchadourian Mar 25 '20 at 21:27
2

When using JDK 8, I set it to 1.8, not 8. Perhaps both work. – russellhoff May 13 '20 at 11:12
Also suggested as the solution in https://bugs.java.com/bugdatabase/view_bug.do?bug_id=8212233 – Gene Gotimer Nov 25 '20 at 21:23
sadly, this is not working for JDK 11 – Carlos Saltos Dec 18 '20 at 18:19

score 23 · Answer 2 · answered May 19 '20 at 06:04

23

Adding <detectJavaApiLink>false</detectJavaApiLink> to the Maven javadoc pluging configuration fix the error

answered May 19 '20 at 06:04

Carlos Saltos

989
11
12

2

This worked for me using AdoptOpenJDK 11.0.8 (2020-07-14) on a Mac. I already had `8` set and it was working for other versions of JDK 11, but not for 11.0.8. – Doug Noel Aug 06 '20 at 12:49

score 16 · Answer 3 · answered Aug 18 '20 at 19:39

16

I needed the bit from Carlos Santos to make this really work. The complete config that incorporates his answer is:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <configuration>
    <source>8</source>
    <detectJavaApiLink>false</detectJavaApiLink>
  </configuration>
</plugin>

answered Aug 18 '20 at 19:39

Scott Seely

677
4
6

1

Thanks. Even without `8`, the above snippet still works for me, in combination with `maven.compiler.source>1111` – eigenfield Nov 06 '20 at 04:15

rü- · Answer 4 · 2019-11-18T14:40:51.447

4

javadoc produces links to packages you use, e.g. to classes documented in .../javase/11/docs/api. While your comments are in an unnamed module, the targets are not, and javadoc can't combine those two. It produces either a package-list or an element-list file, so you can't mix unnamed modules (packages) with named modules.

I didn't find a way to limit the links that javadoc tries to produce; so you may have to use modules for your own project. This seems ridiculous to me, just to make javadoc happy. I guess this is just one of the reasons that so many people stick to Java 8.

edited Nov 18 '19 at 14:40

answered Nov 18 '19 at 12:13

rü-

1,657
11
29

I fully agree. Further it would be helpful if maven-javadoc-plugin would tell which modules are unnamed so you can trace down the problem in a very large project. Also it could offer an option to ignore unnamend modules in aggregation. This does not seem to be the case: https://maven.apache.org/plugins/maven-javadoc-plugin/aggregate-mojo.html – Jörg Oct 23 '20 at 07:22

score 2 · Answer 5 · answered Dec 08 '20 at 21:16

I was able to get my own project to work by using a new version of the compiler plugin and setting the release property to 8.

<plugin>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.8.1</version>
</plugin>

<properties>
    <maven.compiler.release>8</maven.compiler.release>
</properties>

score 0 · Answer 6 · answered Aug 03 '20 at 08:25

0

I was facing the same issue. I was using Java 11.0.3 and org.apache.maven.plugins:maven-javadoc-plugin:2.10.4:jar. Updating the maven-javadoc-plugin version to 3.2.0 worked perfectly for me.

answered Aug 03 '20 at 08:25

Chinmay Kulkarni

11
1
2

1

I am using maven-javadoc-plugin version 3.2.0 and get exactly this error. So that does not fix the issue. – Jörg Oct 23 '20 at 07:19
@Jörg Which Java version are you using? – Chinmay Kulkarni Oct 24 '20 at 13:28
My Java version is 11.0.5+10 – Jörg Oct 25 '20 at 17:06

score 0 · Answer 7 · answered May 06 '21 at 06:36

I have this problem because I used module-info.test approach to unit testing with Java 9 modules.

Simply excluding javadoc generation for tests fixed the issue for me.

                    <reportSet>
                        <reports>
                            <report>javadoc</report>
                            <report>test-javadoc</report>
                        </reports>
                    </reportSet>

Simply remove test-javadoc report.

score -2 · Answer 8 · edited Dec 03 '20 at 13:58

-2

We can use <detectOfflineLinks>false</detectOfflineLinks> in the configuration.

edited Dec 03 '20 at 13:58

Boken

3,207
9
25
31

answered Dec 03 '20 at 11:19

nagachandra immadisetty

7
1

JDK 11+ and Javadoc

8 Answers8

Linked

Related