[
https://issues.apache.org/jira/browse/LUCENE-9201?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17032804#comment-17032804
]
Robert Muir commented on LUCENE-9201:
-------------------------------------
{quote}
Package summary: "ant documentation" uses "package.html" as package summary
description, but "gradlew javadoc" ignores "package.html" (so some packages
lacks summary description in "package-summary.html" when building javadocs by
Gradle). We might be able to make Gradle Javadoc task to properly handle
"package.html" files with some options. Or, should we replace all
"package.html" with "package-info.java" at this time?
{quote}
I found the answer to this. Gradle is fundamentally broken here, its not
possible to fix it.
When ant runs javadocs, we supply just a source directory (-sourcepath) and a
list of packages:
{noformat}
javadoc -sourcepath /home/rmuir/workspace/lucene-solr/lucene/core/src/java
org.apache.lucene org.apache.lucene.analysis
org.apache.lucene.analysis.standard ...
{noformat}
When gradle runs javadocs, it does not do this, it passes each .java file
individually:
{noformat}
javadoc
'/home/rmuir/workspace/lucene-solr/lucene/core/src/java/org/apache/lucene/search/SearcherFactory.java'
'/home/rmuir/workspace/lucene-solr/lucene/core/src/java/org/apache/lucene/search/QueryCache.java'
...
{noformat}
it seems the whole design is to make it work with their SourceTask/FileTree
crap. And you can't pass individual html files to the javadoc tool to
workaround it. It takes only source files or package names.
I can't see any way to pass their task package list the way we do with ant: it
*REALLY* wants to be based on the FileTree. Maybe we should call the ant task
from gradle? They really messed this up.
The other thing that seems really broken is the missing linkoffline. There are
links between the modules (e.g. lucene-analyzers and lucene-core) and the
linkoffline makes that work. But it seems the gradle build is structured to
make per-module output dirs which won't work here.
> Port documentation-lint task to Gradle build
> --------------------------------------------
>
> Key: LUCENE-9201
> URL: https://issues.apache.org/jira/browse/LUCENE-9201
> Project: Lucene - Core
> Issue Type: Sub-task
> Affects Versions: master (9.0)
> Reporter: Tomoko Uchida
> Assignee: Tomoko Uchida
> Priority: Major
> Attachments: javadocGRADLE.png, javadocHTML4.png, javadocHTML5.png
>
> Time Spent: 10m
> Remaining Estimate: 0h
>
> Ant build's "documentation-lint" target consists of those two sub targets.
> * "-ecj-javadoc-lint" (Javadoc linting by ECJ)
> * "-documentation-lint"(Missing javadocs / broken links check by python
> scripts)
--
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
