[LUCENE-10575] Broken links in some javadocs

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 9.2
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Alan Woodward
• Created: 16/May/22 11:20
• Updated: 12/Feb/24 20:41
• Resolved: 17/May/22 10:07

Description

The release wizard for 9.2 has found some broken javadoc links:

• ExternalRefSorter refers to package-private implementations when it should probably refer to the relevant interfaces instead
• STMergingTermsEnum refers to package-private classes.  I think we can solve this by making the whole class package-private, given that it's an implementation detail within a Codec?
• MatchRegionRetriever links to an internal implementation, which should just be described rather than linked.

 

These are all fairly simple to fix, and I will open a PR to do so.  Slightly more worrying is that running `./gradlew lucene:documentation:checkBrokenLinks` does not seem to consistently find these problems.  The release wizard runs against an entirely clean checkout and fails, but attempting to reproduce the failure on an existing checkout produces a green build.  Some of these broken links have been around for a while - the STMergingTermsEnum ones since 2019 - so it may just be luck that I found them this time round.

Issue Links

• links to: GitHub Pull Request #894