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

["Adrien Grand (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/LUCENE-8768?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16821800#comment-16821800 ] 

Adrien Grand commented on LUCENE-8768:
--------------------------------------

[~thetaphi] Any thoughts about this?

> 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
>            Priority: Major
>         Attachments: javadoc-nightly.png, new-javadoc.png
>
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> 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)
> !javadoc-nightly.png!
> ■ After 
> *!new-javadoc.png!*
>  
> I'll change two lines for this.
> 1) change Javadoc's noindex option from true to false.
> {code:java}
> // common-build.xml line 182
> <property name="javadoc.noindex" value="false"/>{code}
> 2) add javadoc argument "--no-module-directories"
> {code:java}
> // common-build.xml line 2100
> <javadoc
>     overview="@{overview}"
>     additionalparam="--no-module-directories" // NEW CODE
>     packagenames="org.apache.lucene.*,org.apache.solr.*"
>     ...
>     maxmemory="${javadoc.maxmemory}">
> {code}
> 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.
>  
>  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org