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

[Javadoc] The search bar takes the user to an incorrect url, resulting in 404 error #152

Closed
AnthonyWeston opened this issue Jan 20, 2022 · 5 comments
Assignees
Milestone

Comments

@AnthonyWeston
Copy link

AnthonyWeston commented Jan 20, 2022

Steps to replicate:

  1. Open https://odftoolkit.org/api/odfdom in the browser
  2. Search for OdfElement in the Search bar
  3. Click the search result for OdfElement
    Expected result: The user is taken to the Javadoc page for the selected item
    Actual result: The user is taken to https://odftoolkit.org/api/odfdom/undefined/org/odftoolkit/odfdom/pkg/OdfElement.html, and sees 404 Not Found on the page.

The user is able to navigate to the page by removing the undefined/ from the url.

@svanteschubert
Copy link
Contributor

Thanks for the pointer, others got this working with the help of the following option in the java doc maven plugin configuration

<additionalJOption>--no-module-directories</additionalJOption>

https://stackoverflow.com/a/52603413/7919834

@AnthonyWeston
Copy link
Author

Thanks for the quick response, but I was referring to the live website at https://odftoolkit.org/api/odfdom rather than a local build.

@svanteschubert
Copy link
Contributor

Yes, indeed, I have not fixed it, yet. Just pointed out the problem. But will do the patch today and ask Michael to review and upload the JavaDoc to the site. Thanks again. :-)

@svanteschubert
Copy link
Contributor

I found out that the problem is just a JDK 11 bug currently: https://bugs.openjdk.java.net/browse/JDK-8244171
referenced from https://bugs.openjdk.java.net/browse/JDK-8215291

Indeed, when building with LTS JDK 17 (Linux) the JavaDoc issue does no longer occur.
I will fix it for the latest version: https://tdf.github.io/odftoolkit/javadoc.html

@mistmist Could you please rebuild the 0.9.0 and 0.10.0 release java doc and copy it to odftoolkit.org?

@mistmist mistmist added this to the 0.11.0 milestone Jan 21, 2022
@mistmist
Copy link
Contributor

fixed by commit c844b27 and copied to odftoolkit.org

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants