[LUCENE-8768] Javadoc search support

• Type: New Feature
• Status: Closed
• Priority: Major
• Resolution: Won't Fix
• Fix Version/s: 9.0
• Lucene Fields: New
• Assignee: Uwe Schindler
• Reporter: Namgyu Kim
• Created: 17/Apr/19 18:25
• Updated: 28/Aug/22 15:44
• Resolved: 19/Apr/19 23:02

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.

 

 

Issue Links

• links to: GitHub Pull Request #650