[
https://issues.apache.org/jira/browse/LUCENE-9242?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17049160#comment-17049160
]
Tomoko Uchida edited comment on LUCENE-9242 at 3/2/20 1:47 PM:
---------------------------------------------------------------
My description about the inter-module links was not good... let me share an
example to clarify a bit the problem I am bumping (though not sure if such
redundant explanation is needed here).
There is a link from {{o.a.l.a.core.KeywordAnalyzer}} to {{o.a.l.a.Analyzer}}.
The {{KeywordAnalyzer}} is placed in "analysis/common" project and {{Analyzer}}
is placed in "core" project so the link is an inter-module (inter-project) link
from "analysis/common" to "core".
[https://lucene.apache.org/core/8_4_0/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html]
The link is represented by a relative path: {{<a
href="../../../../../../core/org/apache/lucene/analysis/Analyzer.html?is-external=true"
title="class or interface in org.apache.lucene.analysis">}}, this is
automatically generated by Ant javadoc task ({{nested <link> element}}). The
link element (without "offline" option) raises errors when the "href" path or
URL cannot be resolved, so you need to be sure to the path is substantial when
invoking javadoc task. This means you have to prepare the very same folder
structure as you'd like to publish at the point of executing javadoc.
Still we can create absolute URL links with "offline" option if the relative
path is not available (Solr has many absolute URL links to Lucene javadocs),
but I feel it's a bit much for inter-project links...
was (Author: tomoko uchida):
My description about the inter-module links was not good... let me share an
example to clarify a bit the problem I am bumping (though not sure if such
redundant explanation is needed here).
There is a link from {{o.a.l.a.core.KeywordAnalyzer}} to {{o.a.l.a.Analyzer}}.
The {{KeywordAnalyzer}} is placed in "analysis/common" project and {{Analyzer}}
is placed in "core" project so the link is an inter-module (inter-project) link
from "analysis/common" to "core".
[https://lucene.apache.org/core/8_4_0/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html]
The link is represented by a relative path: {{<a
href="../../../../../org/apache/lucene/analysis/core/KeywordTokenizer.html"
title="class in org.apache.lucene.analysis.core">}}, this is automatically
generated by Ant javadoc task ({{nested <link> element}}). The link element
(without "offline" option) raises errors when the "href" path or URL cannot be
resolved, so you need to be sure to the path is substantial when invoking
javadoc task. This means you have to prepare the very same folder structure as
you'd like to publish at the point of executing javadoc.
Still we can create absolute URL links with "offline" option if the relative
path is not available (Solr has many absolute URL links to Lucene javadocs),
but I feel it's a bit much for inter-project links...
> Gradle Javadoc task should output the same documents as Ant
> -----------------------------------------------------------
>
> Key: LUCENE-9242
> URL: https://issues.apache.org/jira/browse/LUCENE-9242
> Project: Lucene - Core
> Issue Type: Sub-task
> Components: general/javadocs
> Affects Versions: master (9.0)
> Reporter: Tomoko Uchida
> Priority: Major
> Time Spent: 20m
> Remaining Estimate: 0h
>
> "javadoc" task for the Gradle build does not correctly output package
> summaries, since it ignores "package.html" file in the source tree (so the
> Python linter {{checkJavaDocs.py}} detects that and fails for now.)
> Also the "javadoc" task should make inter-module links just as Ant build does.
> See for more details: LUCENE-9201
--
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
