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

move package.htmls to package-info.java for better tooling support

    Details

    • Type: Task
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 5.1, 6.0
    • Component/s: None
    • Labels:
      None
    • Lucene Fields:
      New

      Description

      Today, on java8, if you typo a link in the package documentation of org.apache.lucene.search (package.html) like this:

      {@link org.apache.lucene.search.TermQueryX TermQuery}
      

      then javadoc will silently do the wrong thing, it will generate a <code>xxx</code> block with no link at all.

      On the other hand, if instead we do it as package-info.java, then it shows up in big red letters as an error in my IDE, doclint catches it at compile time, etc, and we ensure our links are doing what we want.

          [javac] /home/rmuir/workspace/trunk/lucene/core/src/java/org/apache/lucene/search/package-info.java:75: error: reference not found
          [javac]     {@link org.apache.lucene.search.TermQueryX TermQuery}
      

      I think we should cutover? this also helps us rely less on our own linting scripts long term because now doclint is checking these files too.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              rcmuir Robert Muir
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: