[
https://issues.apache.org/jira/browse/LUCENE-8768?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16821955#comment-16821955
]
Uwe Schindler commented on LUCENE-8768:
---------------------------------------
I enabled the javadocs search already for test purposes in the branch but did
not commit it. This had several reasons:
- We are a serach engine, so we should better supply our own javadocs search,
the one in JDK is not really a search its more a lookup mechanism
(autocomplete). So it's actually a very bad-sesigned search engine. If somebody
wants to have it, one can easily pass it in ant, te search as default just
blows it up and makes downloads even larger, one reason why we disabled the
index by default).
- The {{--no-module-directories}} should actually go a few lines lower, as
{{<arg>}}. This is unrelated to this change, but it's good to have, so +1 to
that.
In short: Functionality is there, no patch needed, anybody can create it: {{ant
-Djavadoc.noindex=false documentation}}
I'd only add the module directory extra param to fix the bug (not sure why
this only happens with index enabled). But I am against enabling it in the
Maven / ZIP Javadocs files. We might deploy it to the website, but this can be
done by the release manager using {{ant -Djavadoc.noindex=false documentation}}
> 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-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
