[LUCENE-7338] Broken description section links from documentation to javadocs

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 6.0.2, 6.1.1, 6.2, 7.0
• Component/s: general/javadocs
• Lucene Fields: New
• Assignee: Steven Rowe
• Reporter: Steven Rowe
• Created: 13/Jun/16 17:59
• Updated: 28/Aug/22 14:59
• Resolved: 13/Jun/16 20:41

Description

In Lucene's top-level documentation, there are links to Description sections in Javadocs, e.g. in the Getting Started section: to the Lucene demo; to an Introduction to Lucene's APIs; and to the Analysis overview.

All of these links are anchored at #overview_description or #package_description, but it looks like Java8 switched how these anchors are named: in the 6.0.0, 6.0.1 and now the 6.1.0 RC1 javadocs, these anchors are named with dots rather than underscores: #overview.description and #package.description. As a result, the documentation links go to the right page, but the browser stays at the top of the page because it can't find the now-misnamed anchors.