Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Links in the apidocs are broken #1957

Closed
deining opened this issue Feb 12, 2023 · 3 comments
Closed

Links in the apidocs are broken #1957

deining opened this issue Feb 12, 2023 · 3 comments
Labels
theme: build An issue or change related to the build system type: bug 🐛 type: doc 📘
Milestone

Comments

@deining
Copy link
Contributor

deining commented Feb 12, 2023

I just realized that many links in the apidocs are broken. E.g. have a look at the api doc page for annotation type CommandLine.Option:

At the top of the page you will see these two failing links (many more in the further course of the page):

@Retention(RUNTIME)

Investigating the problem, I realized that /module-name/ is part of the link. The broken link incorrectly uses module name java, it should be java.base. I guess we can overcome this problem by customizing the javadoc task in /gradle/docs.gradle. Haven't looked into this in detail though.

@remkop: can you have a look please? Thanks.

@remkop remkop added this to the 4.7.2 milestone Feb 13, 2023
@remkop remkop added type: bug 🐛 type: doc 📘 theme: build An issue or change related to the build system labels Feb 13, 2023
@remkop
Copy link
Owner

remkop commented Feb 13, 2023

Interesting! Thanks for raising this.

I see:

https://docs.oracle.com/en/java/javase/11/docs/api/java/lang/annotation/Retention.html (actual)
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/annotation/Retention.html (correct)

I do use Java 11 to create the Javadoc, logic is here:
https://github.com/remkop/picocli/blob/main/gradle/modular-javadoc.gradle

Strange that the Javadoc tool for Java 11 creates broken links to pages in Oracle's Java 11 javadoc...
Maybe there is some javadoc option that needs to be specified. I will look in more detail later.

@deining
Copy link
Contributor Author

deining commented Apr 12, 2023

Strange that the Javadoc tool for Java 11 creates broken links to pages in Oracle's Java 11 javadoc...

Indeed. I searched the OpenJDK Bug System and found this issue which looks related:

https://bugs.openjdk.org/browse/JDK-8216169

This bug was resolved with OpenJDK 11.02 however. What java version did you use when building the javadocs?

@remkop
Copy link
Owner

remkop commented Apr 12, 2023

Great find! I was using Java 11 (no minor version)

openjdk version "11" 2018-09-25
OpenJDK Runtime Environment 18.9 (build 11+28)
OpenJDK 64-Bit Server VM 18.9 (build 11+28, mixed mode)

So upgrading to a later minor version may fix this! Thank you for investigating. I will try this soon.

@remkop remkop modified the milestones: 4.7.2, 4.7.3 Apr 14, 2023
@remkop remkop closed this as completed in 00857af Apr 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
theme: build An issue or change related to the build system type: bug 🐛 type: doc 📘
Projects
None yet
Development

No branches or pull requests

2 participants