question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

javadoc links were all broken by move to modules

See original GitHub issue
 * JGraphT version: 1.5.0

For example, in 1.4.0, the Javadoc for the Graphs utility class was at:

https://jgrapht.org/javadoc-1.4.0/org/jgrapht/Graphs.html

Now it’s at:

https://jgrapht.org/javadoc-1.5.0/org.jgrapht.core/org/jgrapht/Graphs.html

Why does this suck? Because we have lots of version-independent links in our docs to things like:

https://jgrapht.org/javadoc/org/jgrapht/Graphs.html

So these all broke in the latest release.

If there’s a way to omit the module from the generated URL’s, or generate redirects, that would be nice, since there are probably lots of incoming links scattered across the web as well.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:10 (10 by maintainers)

github_iconTop GitHub Comments

1reaction
jsichicommented, Jun 19, 2020

I wrote the little script, yet another piece of bash that will surely come back to haunt me in a couple of years or sooner. But for now, all is well.

63421c0945e0f6b416538006c2b0d44e6c2ff7ed

0reactions
jsichicommented, Jun 18, 2020

Well, the problem isn’t our versioning (we already deal with that as part of our release process). The problem is the reorganization of the javadoc file tree due to the changes they made when modules were introduced.

On Thu, Jun 18, 2020, 12:38 AM Dimitrios Michail notifications@github.com wrote:

Any chance we can include a ‘latest’ symlink (directory) and run jekyll with JEKYLL_ENV=production? Just a random suggestion, I am pretty sure it was the first thing you considered.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/jgrapht/jgrapht/issues/950#issuecomment-645839437, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAE2PIIC4SX7V2TAN5NWHPLRXG767ANCNFSM4OAFR2AQ .

Read more comments on GitHub >

github_iconTop Results From Across the Web

Linking between modules in javadoc - Stack Overflow
Javadoc succeeds and generates the HTML. But the links to classes in some (not all) of other modules of my application are broken,...
Read more >
Gradle 7.5 Javadoc plugin is broken for multi-module ... - GitHub
This worked because gradle was adding only --module-path (thanks to modularity.inferModulePath). In Gradle 7.5, the same task fails with: error: ...
Read more >
Broken links when generating from project without modules
A DESCRIPTION OF THE PROBLEM : When you generate javadoc for a project that does not declare modules (no module-info.java source files), navigating...
Read more >
JDK-8212233 javadoc fails on jdk12 with "The code ... - Bug ID
JDK-8212233 : javadoc fails on jdk12 with "The code being documented uses modules but the packages defined in $URL are in the unnamed...
Read more >
Javadoc Command - Oracle Help Center
The module-related options are available for generating documentation. ... For there to be no broken links, all of the documentation for the external ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found