Uploaded image for project: 'Lucene - Core'
  1. Lucene - Core
  2. LUCENE-7338

Broken description section links from documentation to javadocs

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 6.0.2, 6.1.1, 6.2, 7.0
    • Component/s: general/javadocs
    • Labels:
      None
    • Lucene Fields:
      New

      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.

        Attachments

        1. LUCENE-7338.patch
          7 kB
          Steven Rowe

          Activity

            People

            • Assignee:
              sarowe Steven Rowe
              Reporter:
              sarowe Steven Rowe
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: