You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Namgyu Kim (JIRA)" <ji...@apache.org> on 2019/04/17 18:26:00 UTC
[jira] [Created] (LUCENE-8768) Javadoc search support
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.
([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 187
<property name="javadoc.noindex" value="false"/>{code}
2) add javadoc argument "--no-module-directories"
{code:java}
// common-build.xml line 2283
<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