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

Javadoc search support

Details

    • New Feature
    • Status: Closed
    • Major
    • Resolution: Won't Fix
    • None
    • 9.0
    • None
    • None
    • New

    Description

      Javadoc search is a new feature since Java 9.
      (https://openjdk.java.net/jeps/225)

      I think there is no reason not to use it if the current Lucene Java version is 11.

      It can be a great help to developers looking at API documentation.

      (The elastic search also supports it now!
      https://artifacts.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client/7.0.0/org/elasticsearch/client/package-summary.html)

       

      ■ Before (Lucene Nightly Core Module Javadoc)

      ■ After 

       

      I'll change two lines for this.

      1) change Javadoc's noindex option from true to false.

      // common-build.xml line 182
      <property name="javadoc.noindex" value="false"/>

      2) add javadoc argument "--no-module-directories"

      // common-build.xml line 2100
      <javadoc
          overview="@{overview}"
          additionalparam="--no-module-directories" // NEW CODE
          packagenames="org.apache.lucene.*,org.apache.solr.*"
          ...
          maxmemory="${javadoc.maxmemory}">
      

      Currently there is an issue like the following link in JDK 11, so we need "--no-module-directories" option.
      (https://bugs.openjdk.java.net/browse/JDK-8215291)

       

      ■ How to test

      I did "ant javadocs-modules" on lucene project and check Javadoc.

       

       

      Attachments

        1. new-javadoc.png
          88 kB
          Namgyu Kim
        2. LUCENE-8768.patch
          1 kB
          Uwe Schindler
        3. LUCENE-8768.patch
          2 kB
          Uwe Schindler
        4. javadoc-nightly.png
          68 kB
          Namgyu Kim

        Issue Links

          Activity

            People

              uschindler Uwe Schindler
              danmuzi Namgyu Kim
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 0.5h
                  0.5h