[ https://issues.apache.org/jira/browse/LUCENE-9278?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17070336#comment-17070336 ]
Tomoko Uchida edited comment on LUCENE-9278 at 3/29/20, 1:20 PM: ----------------------------------------------------------------- I opened another PR: [https://github.com/apache/lucene-solr/pull/1388]. This replaces all relative paths with absolute urls by {{-linkoffline}} option, so that javadoc destination directory is moved under {{_project_/build/}}. - docs of ":lucene:core" prj will go to {{lucene/core/build/docs/javadoc/}} - docs of ":lucene:analysis:common" will go to {{lucene/analysis/common/build/docs/javadoc/}} - docs of ":solr:core" prj will go to {{solr/core/build/docs/javadoc/}} - ... and so on Also, this directly calls [javadoc tool|https://docs.oracle.com/en/java/javase/11/tools/javadoc.html] rather than Ant javadoc task - Ant javadoc task doesn't recognize {{element-list}}, the successor to {{package-list}} up until Java 8, so {{<link offline="true" .../>}} no longer correctly work with JDK11 (SOLR-14352). All generated docs are passed the "checkJavaDocs.py" check. In other words, there's no missing package summary (we had some missing package summary problem with gradle default javadoc task). [~dweiss] I think our custom javadoc task (for gradle build) is almost complete with the changes. Would you review it again? was (Author: tomoko uchida): I opened another PR: [https://github.com/apache/lucene-solr/pull/1388]. This replaces all relative paths with absolute urls by {{-linkoffline}} option, so that javadoc destination directory is moved under {{_project_/build/}}. - docs of ":lucene:core" prj will go to {{lucene/core/build/docs/javadoc/}} - docs of ":lucene:analysis:common" will go to {{lucene/analysis/common/build/docs/javadoc/}} - docs of ":solr:core" prj will go to {{solr/core/build/docs/javadoc/}} - ... and so on Also, this directly calls [javadoc tool|https://docs.oracle.com/en/java/javase/11/tools/javadoc.html] rather than Ant javadoc task - Ant javadoc task doesn't recognize {{element-list}}, the successor to {{package-list}} up until Java 8, so {{<link offline=true/>}} no longer correctly work with JDK11 (SOLR-14352). All generated docs are passed the "checkJavaDocs.py" check. In other words, there's no missing package summary (we had some missing package summary problem with gradle default javadoc task). [~dweiss] I think our custom javadoc task (for gradle build) is almost complete with the changes. Would you review it again? > Make javadoc folder structure follow Gradle project path > -------------------------------------------------------- > > Key: LUCENE-9278 > URL: https://issues.apache.org/jira/browse/LUCENE-9278 > Project: Lucene - Core > Issue Type: Task > Components: general/build > Reporter: Tomoko Uchida > Priority: Major > Time Spent: 1h 50m > Remaining Estimate: 0h > > Current javadoc folder structure is derived from Ant project name. e.g.: > [https://lucene.apache.org/core/8_4_1/analyzers-icu/index.html] > [https://lucene.apache.org/solr/8_4_1/solr-solrj/index.html] > For Gradle build, it should also follow gradle project structure (path) > instead of ant one, to keep things simple to manage [1]. Hence, it will look > like this: > [https://lucene.apache.org/core/9_0_0/analysis/icu/index.html] > [https://lucene.apache.org/solr/9_0_0/solr/solrj/index.html] > [1] The change was suggested at the conversation between Dawid Weiss and I on > a github pr: [https://github.com/apache/lucene-solr/pull/1304] -- This message was sent by Atlassian Jira (v8.3.4#803005) --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org