You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by "Tomoko Uchida (Jira)" <ji...@apache.org> on 2020/03/22 10:05:00 UTC

[jira] [Commented] (SOLR-14352) External links from Solr Javadocs to Lucene docs is broken on the master (9.0.0)

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

Tomoko Uchida commented on SOLR-14352:
--------------------------------------

This is not an issue of JDK11 Javadoc Tool. When I directly call javadoc tool by this command, I see that the tool properly found packages to be linked from {{element-file}} and the hyperlinks are generated, without the patch I attached here.
{code:java}
$ javadoc -cp lucene/core/build/libs/lucene-core-9.0.0-SNAPSHOT.jar:lucene/build/analysis/common/lucene-analyzers-common-9.0.0-SNAPSHOT.jar \
   -sourcepath solr/core/src/java org.apache.solr.analysis \
   -linkoffline https://lucene.apache.org/core/9_0_0/core lucene/build/docs/core \
   -d /tmp/docs
{code}
I noticed this problem when I ported Ant javadocs task to Gradle build (LUCENE-9242 and LUCENE-9278). If the fix is fine, I will apply the same patch on Gradle build too, since our custom gradle javadoc task is built on Ant javadoc for now. (Or, for gradle build we could directly call javadoc tool instead of invoking Ant.)

> External links from Solr Javadocs to Lucene docs is broken on the master (9.0.0)
> --------------------------------------------------------------------------------
>
>                 Key: SOLR-14352
>                 URL: https://issues.apache.org/jira/browse/SOLR-14352
>             Project: Solr
>          Issue Type: Bug
>      Security Level: Public(Default Security Level. Issues are Public) 
>    Affects Versions: master (9.0)
>            Reporter: Tomoko Uchida
>            Assignee: Tomoko Uchida
>            Priority: Major
>         Attachments: SOLR-14352.patch, javadoc_solr_branch8x.png, javadoc_solr_master.png
>
>
> On branch_8x (w/ java 8), "ant javadocs" generates external links from Solr docs to Lucene docs like the capture:
> !javadoc_solr_branch8x.png!
> On the master branch (w/ java11), the links are not created with the same command:
> !javadoc_solr_master.png!
> It looks like the Ant javadoc task does not recognize the {{element-list}} file, that was introduced at (maybe) Java10 as the replacement of {{package-list}}. (See also https://docs.oracle.com/en/java/javase/11/tools/javadoc.html)



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

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