[jira] [Created] (LUCENE-8768) Javadoc search support

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

[jira] [Created] (LUCENE-8768) Javadoc search support

Niranjan Nanda (Jira)
Namgyu Kim created LUCENE-8768:

             Summary: Javadoc search support
                 Key: LUCENE-8768
                 URL: https://issues.apache.org/jira/browse/LUCENE-8768
             Project: Lucene - Core
          Issue Type: New Feature
            Reporter: Namgyu Kim
         Attachments: javadoc-nightly.png, new-javadoc.png

Javadoc search is a new feature since Java 9.

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!


*- 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 187
<property name="javadoc.noindex" value="false"/>{code}

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

// common-build.xml line 2283
    additionalparam="--no-module-directories" // NEW CODE
Currently there is an issue like the following link in JDK 11, so we need "--no-module-directories" option.


*- How to test -*

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



This message was sent by Atlassian JIRA

To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]